Document log metadata API

[Anikesh Thakur (Anikesh348)]

Summary

• document the LogFileSegment public contract and constants
• document public metadata constructors and accessors
• clarify the ordering and meaning of single and rotating log segments

Contributes to #264.

Verification

• ./mvnw -Dmaven.compiler.release=17 -pl api -am -DskipTests compile
• ./mvnw -Dmaven.compiler.release=17 -pl api javadoc:javadoc
• A full API test run was also attempted, but the existing RotatingGCLogTest could not find its
  G1-80-16gbps2.log fixture in this checkout. The failure is unrelated to this documentation-only
  change.

AI assistance disclosure

Codex assisted with issue selection, drafting the Javadocs, running verification, and publishing
the prepared contribution. The resulting documentation and diff were inspected against the source
behavior before publication.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Anikesh Thakur (Anikesh348)]

@microsoft-github-policy-service agree