Skip to content

Javadoc field info v2 #1052

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.

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

Open
wants to merge 1 commit into
base: adv/docs
Choose a base branch
from
Open

Javadoc field info v2 #1052

wants to merge 1 commit into from

Conversation

peter-lawrey
Copy link
Member

📝 Pull-request summary

*Aim: modernise and document the field-metadata layer (FieldInfo and friends)


1. API & type housekeeping

Change Details
Static import rationalisation Added import static net.openhft.chronicle.wire.Wires.*; in FieldInfo.java to remove repetitive qualifiers. No behavioural impact.

2. Documentation lift

  • FieldInfo interface

    • Full Javadoc rewrite: clearer contract, param/return docs for every method, examples of bracket semantics.
    • Detailed explanation of lookupClass reflection path.
  • AbstractFieldInfo

    • Added field-level Javadoc, ctor explanations and hash/equals clarifications.
  • Unsafe / reflection subclasses

    • VanillaFieldInfo, UnsafeFieldInfo and the primitive specialisations (IntFieldInfo, LongFieldInfo, CharFieldInfo, DoubleFieldInfo, ObjectFieldInfo) now all include:

      • purpose + behaviour summary
      • param docs for ctors
      • notes on error handling and equality semantics.

@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:26
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.

1 participant