Docs & naming cleanup for LongConverter family
#1143
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
* Improve Javadoc for long conversion * Enhance Javadoc for LongConversion to clarify converter class requirements * Improve Javadoc for WireDumper and Wires classes to enhance clarity and understanding
peter-lawrey
changed the title
LongConverter family
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.
📝 Docs & naming cleanup for
LongConverterfamilyThis PR is a zero-logic, comments-only refresh that brings the whole “symbol/power-of-two long encoding” stack up to Chronicle’s current documentation standards and aligns parameter names across the board.
What changed?
AbstractLongConverter.javachars ➜ symbolSet,converter ➜ underlyingConverter, etc.) for intent clarity.* Added full Javadoc for ctors and public methods; each param/return now explained.
LongConverter.java* Added/expanded docs for every method; clarified error handling & default impl caveats.
* Renamed local param names (
text ➜ textToParse,value ➜ numericValue, etc.) to match spec.LongConversion.javaPowerOfTwoLongConverter.javaSymbolsLongConverter.java* In-line comments to make bit-shifts & truncation logic self-explanatory.
PowerOfTwoLongConverter,SymbolsLongConverterNo unit-test or runtime code paths were altered — all changes are limited to comments, parameter identifiers and log/exception text.