Skip to content

Conversation

@andymarek
Copy link
Contributor

@andymarek andymarek commented Dec 27, 2025

This PR fixes JavaDoc code block formatting across the codebase to ensure proper rendering in generated documentation.

Changes

  • Replaced legacy JavaDoc {@code ...} blocks with the more reliable <pre><code>...</code></pre> pattern for multi-line code examples
  • Converted generic type angle brackets (<>) to HTML entities (&lt;&gt;) to prevent HTML parsing issues in JavaDoc output
  • Removed unnecessary curly brace wrappers and @code annotations that were causing formatting inconsistencies
  • Applied consistent formatting style to 11 files across the core and mallet modules

Testing

  • Executed GitHub Actions

@github-actions
Copy link

Code Coverage

Overall Project 98.37% 🍏
Module Coverage
mallet 99.49% 🍏
core 97.53% 🍏
Files
Module File Coverage
mallet ModelOutputEvaluator.java 100% 🍏
ConllOutputConfiguration.java 100% 🍏
MalletCrfTrainer.java 100% 🍏
ModelOutputConfiguration.java 100% 🍏
MalletCrfTrainerConfiguration.java 98.74% 🍏
core TransformingFeatureExtractor.java 100% 🍏
PatternMatchingFeatureExtractor.java 100% 🍏
CompositeFeatureExtractor.java 100% 🍏
Serializables.java 100% 🍏
InputSequence.java 100% 🍏
XPathFeatureExtractor.java 93.14% 🍏

@andymarek andymarek merged commit b51ac71 into main Dec 27, 2025
3 checks passed
@andymarek andymarek deleted the support/code branch December 27, 2025 20:05
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