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

Correctly escape Javadoc code snippets #1397

Merged
merged 1 commit into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG_PENDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@

### Bug Fixes

- Correctly escape special characters in generated Javadocs.
Original file line number Diff line number Diff line change
Expand Up @@ -702,20 +702,20 @@
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* public class App }{{@code
* public static void main(String[] args) }{{@code
* Pulumi.run(App::stack);
* }
* }}{@code
*
* public static void stack(Context ctx) {
* public static void stack(Context ctx) }{{@code
* // This is an example of an Email connection.
* var passwordlessEmail = new Connection("passwordlessEmail", ConnectionArgs.builder()
* .strategy("email")
* .name("email")
* .options(ConnectionOptionsArgs.builder()
* .name("email")
* .from("{{ application.name }} \u003croot{@literal @}auth0.com\u003e")
* .subject("Welcome to {{ application.name }}")
* .from("}{{{@code application.name }}}{@code \u003croot}{@literal @}{@code auth0.com\u003e")
* .subject("Welcome to }{{{@code application.name }}}{@code ")
* .syntax("liquid")
* .template("\u003chtml\u003eThis is the body of the email\u003c/html\u003e")
* .disableSignup(false)
Expand All @@ -733,8 +733,8 @@
* .build())
* .build());
*
* }
* }
* }}{@code
* }}{@code
* }
* </pre>
* \u003c!--End PulumiCodeChooser --\u003e
Expand Down Expand Up @@ -763,12 +763,12 @@
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* public class App }{{@code
* public static void main(String[] args) }{{@code
* Pulumi.run(App::stack);
* }
* }}{@code
*
* public static void stack(Context ctx) {
* public static void stack(Context ctx) }{{@code
* // This is an example of a SAML connection.
* var samlp = new Connection("samlp", ConnectionArgs.builder()
* .name("SAML-Connection")
Expand All @@ -786,11 +786,11 @@
* .protocolBinding("urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST")
* .requestTemplate("""
* \u003csamlp:AuthnRequest xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
* {@literal @@}AssertServiceURLAndDestination{@literal @@}
* ID="{@literal @@}ID{@literal @@}"
* IssueInstant="{@literal @@}IssueInstant{@literal @@}"
* ProtocolBinding="{@literal @@}ProtocolBinding{@literal @@}" Version="2.0"\u003e
* \u003csaml:Issuer xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"\u003e{@literal @@}Issuer{@literal @@}\u003c/saml:Issuer\u003e
* }{@literal @@}{@code AssertServiceURLAndDestination}{@literal @@}{@code
* ID="}{@literal @@}{@code ID}{@literal @@}{@code "
* IssueInstant="}{@literal @@}{@code IssueInstant}{@literal @@}{@code "
* ProtocolBinding="}{@literal @@}{@code ProtocolBinding}{@literal @@}{@code " Version="2.0"\u003e
* \u003csaml:Issuer xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"\u003e}{@literal @@}{@code Issuer}{@literal @@}{@code \u003c/saml:Issuer\u003e
* \u003c/samlp:AuthnRequest\u003e """)
* .userIdAttribute("https://saml.provider/imi/ns/identity-200810")
* .signatureAlgorithm("rsa-sha256")
Expand Down Expand Up @@ -822,21 +822,21 @@
* .signingKey(ConnectionOptionsSigningKeyArgs.builder()
* .key("""
* -----BEGIN PRIVATE KEY-----
* ...{your private key here}...
* ...}{{@code your private key here}}{@code ...
* -----END PRIVATE KEY----- """)
* .cert("""
* -----BEGIN CERTIFICATE-----
* ...{your public key cert here}...
* ...}{{@code your public key cert here}}{@code ...
* -----END CERTIFICATE----- """)
* .build())
* .decryptionKey(ConnectionOptionsDecryptionKeyArgs.builder()
* .key("""
* -----BEGIN PRIVATE KEY-----
* ...{your private key here}...
* ...}{{@code your private key here}}{@code ...
* -----END PRIVATE KEY----- """)
* .cert("""
* -----BEGIN CERTIFICATE-----
* ...{your public key cert here}...
* ...}{{@code your public key cert here}}{@code ...
* -----END CERTIFICATE----- """)
* .build())
* .idpInitiated(ConnectionOptionsIdpInitiatedArgs.builder()
Expand All @@ -847,8 +847,8 @@
* .build())
* .build());
*
* }
* }
* }}{@code
* }}{@code
* }
* </pre>
* \u003c!--End PulumiCodeChooser --\u003e
Expand Down
Loading
Loading