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.

Sign up for GitHub

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

Jump to bottom

Add more JavaDoc #169

Open
sjoerdtalsma opened this issue Jun 4, 2019 · 1 comment
Open

Add more JavaDoc #169

sjoerdtalsma opened this issue Jun 4, 2019 · 1 comment
Labels
documentation good first issue

Comments

@sjoerdtalsma
Copy link
Contributor

Expected Behavior

The UMLDoclet uses itself for examples; would be nice if the JavaDoc was of acceptable level too.

Actual Behavior

Not much is documented.

Steps to Reproduce the Problem

  1. Look for package documentation.
  2. A concise single-line comment followed by more extensive explanation is ideal.

Specifications

  • Version: 2.x
  • Platform: any
  • Java version: 9+
  • (If open source) Project link:
@sjoerdtalsma
Copy link
Contributor Author

A good approach could be to start reading the Javadoc from the UMLDoclet itself and whenever something is not clear or undocumented, add it to your local copy and regenerate the documentation.

Don't forget to commit often and push to a branch at your own fork.
When you're satisfied with the change(s), create a pull request to get your changes merged 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sjoerdtalsma