Skip to content

Add Javadoc URLs into Vendor dependency JSONs #8683

@ApolloFops

Description

@ApolloFops

Is your feature request related to a problem? Please describe.

Javadoc has this neat little feature where you can specify links to external docs, which then, when you link to those classes, they get linked in the docs (here's an example of a build.gradle file with this, and a page from the resulting docs that links to the PathPlanner docs for something). This is a really useful thing to have when you're navigating docs, but it can end up being kinda annoying to maintain, especially since vendors will often not do a fantastic job of maintaining their hosted Javadocs.

Describe the solution you'd like

Some sort of a field in the Javadocs that adds a URL to this list. Also this could be used to add a "go to API docs" button in the Vendordep manager or something (could be worth adding a field for C++ API docs as well for this purpose).

Describe alternatives you've considered

Just configuring it manually like above.

Additional context

I'd be willing to implement this myself if there's interest for it, just don't wanna implement it and never actually have it be merged lol.

Also not entirely sure where this issue should go since the functionality it's related to is strewn across a few different places, so I'm just gonna stick it here for now.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type: featureBrand new functionality, features, pages, workflows, endpoints, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions