Add package-level annotations and Javadoc #10
Merged
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 adds comprehensive package-level documentation and
@NullMarkedannotations across all packages in the CRF library. The documentation includes usage examples, API references, and configuration guides to help developers understand and use the library effectively.Changes
Package-level null safety: Added
package-info.javafiles with@NullMarkedannotations to all 8 packages (6 in core module, 2 in mallet module), establishing null safety at the package levelCore module documentation:
org.coordinatekit.crf.core- Documented core abstractions (TagProvider, Sequence, InputSequence, PositionedToken)org.coordinatekit.crf.core.preprocessing- Listed all 8 FeatureExtractor implementations with an example showing how to combine extractors using CompositeFeatureExtractororg.coordinatekit.crf.core.tag- Documented tagging result types (CrfTagger, TaggedSequence, TaggedPositionedToken, TagScore)org.coordinatekit.crf.core.io- Documented training data I/O and XML formatorg.coordinatekit.crf.core.train- Documented training interfaceorg.coordinatekit.crf.core.util- Documented utility classesMallet module documentation:
org.coordinatekit.crf.mallet.train- Added complete example showing MalletCrfTrainer configuration including ModelOutputConfiguration and ConllOutputConfiguration, plus documentation of all configuration optionsorg.coordinatekit.crf.mallet.tag- Added example showing how to create a tagger, tag input, and process results with tag scoresJavadoc improvements: Added JSpecify API link to the aggregateJavadoc task so annotations like
@NullMarkedlink to their documentationTesting