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

Improve javadocs with <group> tags. #6304

Merged
merged 3 commits into from
Nov 14, 2022
Merged

Improve javadocs with <group> tags. #6304

merged 3 commits into from
Nov 14, 2022

Conversation

ggvbo
Copy link
Contributor

@ggvbo ggvbo commented Nov 14, 2022

Description:

This PR includes some improvements to the way Javadocs are generated on build:

  • Updates maven-javadoc-plugin
  • Adds groups, allowing for an better and easier navigation through the documentation
  • Switched an usage of an plain text link to an <a> tag

New Nodes/Commands/ConfigOptions:


Relevant Towny Issue ticket:


  • I have tested this pull request for defects on a server.

By making this pull request, I represent that I have the right to waive copyright and related rights to my contribution, and agree that all copyright and related rights in my contributions are waived, and I acknowledge that the TownyAdvanced organization has the copyright to use and modify my contribution under the Towny License for perpetuity.

Allows for easier navigation of Javadocs
Tested-by: Gabriel Arriagada <65878291+gnosii@users.noreply.github.com>
Allows for interaction with the link.

Tested-by: Gabriel Arriagada <65878291+gnosii@users.noreply.github.com>
Copy link
Member

@LlmDl LlmDl left a comment

Choose a reason for hiding this comment

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

I like how the groups look when it generates the javadocs. Just change the source back to 16.

pom.xml Outdated Show resolved Hide resolved
Goes back to hard-coded Java 16 as requested by LlmDl
@ggvbo ggvbo requested a review from LlmDl November 14, 2022 17:50
@LlmDl LlmDl added this to the 0.98.5.0 milestone Nov 14, 2022
@LlmDl LlmDl changed the title Javadocs improvement Improve javadocs with <group> tags. Nov 14, 2022
@LlmDl LlmDl merged commit a5889fd into TownyAdvanced:master Nov 14, 2022
@ggvbo ggvbo deleted the javadocs-improvement branch November 15, 2022 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants