Javadocs for #604 #605
Merged
Javadocs for #604 #605
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a code example in tests of replacing the "system-lambda" library specific to our needs of checking program output to the terminal/console. The `ContextForTerminal` test class is reusable, but unclear we should provide this even as copy/paste for folks browsing our test code. Along the way: - Find that the PMD rule on "CommentSize" is awful. We should suppress it by default. When you write large comments (for example, in Javadoc) your build should not break. - Suppressions of PMD checks, or rewriting for Checkstyle. This is a smell that either code is wonky, or this is too low-level to make a good example. - Reminder that the old Java APIs only dealt with UTF issues in a half-ass fashion. A reason to use libraries that dealt with this for you. - Reminder that terminal/console out/err is not thread-safe, and no library can fix that.
This is a code example in tests of replacing the "system-lambda" library specific to our needs of checking program output to the terminal/console. The `ContextForTerminal` test class is reusable, but unclear we should provide this even as copy/paste for folks browsing our test code. Along the way: - Find that the PMD rule on "CommentSize" is awful. We should suppress it by default. When you write large comments (for example, in Javadoc) your build should not break. - Suppressions of PMD checks, or rewriting for Checkstyle. This is a smell that either code is wonky, or this is too low-level to make a good example. - Reminder that the old Java APIs only dealt with UTF issues in a half-ass fashion. A reason to use libraries that dealt with this for you. - Reminder that terminal/console out/err is not thread-safe, and no library can fix that.
IntelliJ is happier with the line breaks in this commit. Also, update the javadocs with better links and wording.
This does not yet generate javadocs in Maven, but sets up the basic dependency for the Maven javadoc plugin so that CI dependabot will keep us up to date.
This includes main code and test code, but not integration test code. Find results in `target/site/apidocs` and `target/site/testapidocs`.
Making things public helps with Javadoc generation.
1. Generate local documentation under `target/site` for browsing. 2. Generate jars of main and test javadocs for sharing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is for card #604.
Note the "To Decide" part of the card!
As the implementation on this branch stands now:
Perhaps these "To Decide" things should be moved to discussion in the wiki page.
References: