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

Consolidate Javadoc #107

Open
occupant23 opened this issue Dec 5, 2019 · 1 comment
Open

Consolidate Javadoc #107

occupant23 opened this issue Dec 5, 2019 · 1 comment
Assignees
Labels
docsReadyForMerge Documentation was created for this issue in a separate branch which is ready to merge to develop improvement Low Priority
Milestone

Comments

@occupant23
Copy link
Contributor

At the moment our Javadoc is not very uniform.

Review the whole Javadoc of the project, especially regarding the following subjects:

  • Consolidate upper/lower case in the beginning of lines to the standard (review some Javadoc documents of bigger well maintained projects to decide)
  • Add an section heading "Example:" to all examples
  • Add a new Javadoc to functions, that are part of our API but have none
  • Update/Clarify the wording of the Javadoc in order the be better understandable
  • Recheck our Wiki and update phrases used in both documentations accordingly

Please create a own branch for this issue since this task will be ongoing and merged with every release in between.

@occupant23 occupant23 added improvement docsReadyForMerge Documentation was created for this issue in a separate branch which is ready to merge to develop Low Priority labels Dec 5, 2019
@occupant23 occupant23 added this to the backlog milestone Dec 5, 2019
@h-arlt
Copy link
Contributor

h-arlt commented Dec 17, 2019

IMO we should stick with JavaDoc convention used by JDK itself.
That means: all text passed to doclets (that stuff beginning with '@') should start lower-case.

@occupant23 occupant23 modified the milestones: backlog, v4.1.0 Oct 1, 2020
@occupant23 occupant23 modified the milestones: v4.1.0, v4.2.0 Oct 29, 2020
@occupant23 occupant23 modified the milestones: v4.2.0, backlog Feb 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsReadyForMerge Documentation was created for this issue in a separate branch which is ready to merge to develop improvement Low Priority
Projects
None yet
Development

No branches or pull requests

3 participants