Skip to content
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

Cleanup enum generation #52

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Conversation

jack-berg
Copy link
Member

Resolves #49.

  • Adds enum javadoc pointing back to corresponding attribute constant
  • Add deprecated javadoc / annotation based on same rules as attributes
  • Exclude the // Enum definitions comment if a namespace doesn't have any enums

@jack-berg jack-berg requested a review from a team March 14, 2024 21:18
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpAttributes.HttpRequestMethodValues} attribute.
*/
@Deprecated
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good example of the deprecated annotation. Javadoc links back to the stable equivalent.

@jack-berg jack-berg merged commit 379efda into open-telemetry:main Mar 14, 2024
12 checks passed
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.

Generate javadoc / deprecated annotations for enum definitions
2 participants