Skip to content

Document experimental type routing in OtelObjectRule Javadoc #8570

Description

@thswlsqls

Is your feature request related to a problem? Please describe.
The class-level Javadoc of OtelObjectRule (buildSrc/src/main/java/io/opentelemetry/gradle/js2p/OtelObjectRule.java line 27-30) documents only one of the rule's two responsibilities: replacing jsonschema2pojo's generated toString/equals/hashCode. It omits the other responsibility that apply() (line 46-48) performs, routing experimental classes into the internal sub-package via ExperimentalPackages.resolve(...). The three sibling classes (OtelRuleFactory, OtelEnumRule, ExperimentalPackages) all describe this routing, so the class that performs it is the only one whose Javadoc leaves it out.

Describe the solution you'd like
Add the routing responsibility to the class Javadoc, placing the routing clause first and reusing OtelRuleFactory's existing wording ("routes experimental classes into the internal sub-package"). Docs-only, backward compatible.

Describe alternatives you've considered
N/A.

Spec alignment
N/A. This is internal build tooling (declarative-config POJO generation), not covered by the OpenTelemetry Specification.

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions