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

Replace code examples in Javadoc with JEP 413: Code Snippets #880

Closed
jenetics opened this issue Aug 8, 2023 · 1 comment
Closed

Replace code examples in Javadoc with JEP 413: Code Snippets #880

jenetics opened this issue Aug 8, 2023 · 1 comment
Assignees
@jenetics
Labels
enhancement examples java21
Milestone
v8.0.0

Comments

@jenetics
Copy link
Owner

jenetics commented Aug 8, 2023

The code examples in the library are currently put in a <pre>{@code }</pre> block, which is additionally higlighted via a proprietary code highlighter. In this ticket, all code example should be using the new {@snippet : } Javadoc feature. The code examples should also be compileable, so that is no longer the case to have invalid examples in the Javadoc.
@jenetics jenetics added this to the v8.0.0 milestone Aug 8, 2023
jenetics added a commit that referenced this issue Aug 31, 2023
@jenetics
#880: Prepare for using code snippet tag.
0879c55 
Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>
jenetics added a commit that referenced this issue Aug 31, 2023
@jenetics
#880: Use code snippets for code examples.
a7adc7c 
Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>
jenetics added a commit that referenced this issue Aug 31, 2023
@jenetics
#880: Remove code snippet colorizer.
db0dc62 
Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>
jenetics added a commit that referenced this issue Aug 31, 2023
@jenetics
#880: Fix snippet.
e22f543 
Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>
jenetics added a commit that referenced this issue Aug 31, 2023
@jenetics
Merge pull request #881 from jenetics/issues/JENETICS-880-code_snippets
685a303 
#880: Use code snippets for code examples
@jenetics jenetics self-assigned this Aug 31, 2023
@jenetics
Copy link
Owner Author

Merged into r8.0.0 branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jenetics jenetics

Labels
enhancement examples java21
Projects
None yet
Milestone
v8.0.0
Development

No branches or pull requests
1 participant
@jenetics