Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add source documentation to javadocs and add dependency tab #3917

Merged
merged 1 commit into from Jan 11, 2023

Conversation

NotMyFault
Copy link
Member

@NotMyFault NotMyFault commented Jan 9, 2023

  • isLinkSource generates HTML files for all classes to facilitate browsing javadocs without the need to change between source code and back
  • isUse adds a dedicated "USE" tab to the navbar to visualize class dependencies
  • keywords adds some optional metadata for search engines
  • bottom adds a footer, to be considered, but I found it a funny idea :)

@NotMyFault NotMyFault added the Developer Note worth changes for API users label Jan 9, 2023
@NotMyFault NotMyFault requested a review from a team as a code owner January 9, 2023 12:35
@github-actions github-actions bot added the documentation This PR addresses documentation issues label Jan 9, 2023
Copy link
Member

@SirYwell SirYwell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool

@NotMyFault NotMyFault removed the Developer Note worth changes for API users label Jan 11, 2023
@NotMyFault NotMyFault changed the title Get the most out of javadocs Add source documentation to javadocs and add dependency tab Jan 11, 2023
@NotMyFault NotMyFault merged commit 0f00309 into v6 Jan 11, 2023
@NotMyFault NotMyFault deleted the javadoc-cleanup branch January 11, 2023 17:25
yannicklamprecht pushed a commit to Craftstuebchen/PlotSquared that referenced this pull request Jan 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This PR addresses documentation issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants