-
Notifications
You must be signed in to change notification settings - Fork 50
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
Java SDK does not pass javadoc #1979
Labels
kind/bug
Some behavior is incorrect or out of spec
Comments
3 tasks
t0yv0
pushed a commit
to pulumi/pulumi-java
that referenced
this issue
Apr 30, 2024
<!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes #1271 Correctly scope comment escapes to outside of code blocks. The resulting code is both more idiomatic javadoc and safe to embed. I have two motivating examples: 1. Correctness: Upstream comments that start lines with `@pattern` will now be escaped to `{@literal @}pattern`. This has prevented us from publishing in the past (pulumi/pulumi-gcp#1950, pulumi/pulumi-auth0#516, pulumi/pulumi-azure#1979) 2. Idiomaticity: Generated code blocks will no longer be HTML escaped (since they don't need to be). Instead, they will render correctly. ## Checklist <!--- Please provide details if the checkbox below is to be left unchecked. --> - [X] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [ ] I have updated the [CHANGELOG-PENDING](https://github.com/pulumi/pulumi/blob/master/CHANGELOG_PENDING.md) file with my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Service, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version <!-- @pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The java SDK does not pass javadoc. It fails with:
The text was updated successfully, but these errors were encountered: