Closed iwahbe closed 3 months ago
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:
Correctness: Upstream comments that start lines with @pattern will now be escaped to {@literal @}pattern. This has prevented us from publishing in the past (https://github.com/pulumi/pulumi-gcp/issues/1950, https://github.com/pulumi/pulumi-auth0/issues/516, https://github.com/pulumi/pulumi-azure/issues/1979)
@pattern
{@literal @}pattern
Idiomaticity: Generated code blocks will no longer be HTML escaped (since they don't need to be). Instead, they will render correctly.
Description
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:
Correctness: Upstream comments that start lines with
@patternwill now be escaped to{@literal @}pattern. This has prevented us from publishing in the past (https://github.com/pulumi/pulumi-gcp/issues/1950, https://github.com/pulumi/pulumi-auth0/issues/516, https://github.com/pulumi/pulumi-azure/issues/1979)Idiomaticity: Generated code blocks will no longer be HTML escaped (since they don't need to be). Instead, they will render correctly.
Checklist