fix(java): Escape */ in package-info.java (#526)

Code examples in the `README.md` file can contain multi-line comments that will interfere with the comment block in `package-info.java`. Escaping the `*/` to `*{@literal /}` fixes that issue.
aws · Jun 7, 2019 · 4e7ea98 · 4e7ea98
1 parent 7ffa98d
commit 4e7ea98
Show file tree

Hide file tree

Showing 21 changed files with 38 additions and 25 deletions.
diff --git a/packages/codemaker/package-lock.json b/packages/codemaker/package-lock.json
diff --git a/packages/jsii-calc/README.md b/packages/jsii-calc/README.md
@@ -10,6 +10,9 @@ If this file starts with an "H1" line (in our case `# jsii Calculator`), this
 heading will be used as the Sphinx topic name. Otherwise, the name of the module
 (`jsii-calc`) will be used instead.
 
+## Code Samples
 
-
-
+```ts
+/* This is totes a magic comment in here, just you wait! */
+const foo = 'bar';
+```
diff --git a/packages/jsii-calc/test/assembly.jsii b/packages/jsii-calc/test/assembly.jsii
@@ -197,7 +197,7 @@
   },
   "name": "jsii-calc",
   "readme": {
-    "markdown": "# jsii Calculator\n\nThis library is used to demonstrate and test the features of JSII\n\n## Sphinx\n\nThis file will be incorporated into the sphinx documentation.\n\nIf this file starts with an \"H1\" line (in our case `# jsii Calculator`), this\nheading will be used as the Sphinx topic name. Otherwise, the name of the module\n(`jsii-calc`) will be used instead.\n\n\n\n\n"
+    "markdown": "# jsii Calculator\n\nThis library is used to demonstrate and test the features of JSII\n\n## Sphinx\n\nThis file will be incorporated into the sphinx documentation.\n\nIf this file starts with an \"H1\" line (in our case `# jsii Calculator`), this\nheading will be used as the Sphinx topic name. Otherwise, the name of the module\n(`jsii-calc`) will be used instead.\n\n## Code Samples\n\n```ts\n/* This is totes a magic comment in here, just you wait! */\nconst foo = 'bar';\n```\n"
   },
   "repository": {
     "type": "git",
@@ -8604,5 +8604,5 @@
     }
   },
   "version": "0.11.1",
-  "fingerprint": "uCNbkp5+1duLs9lW2h4C+T4dTtV6ZArNhzgT39ChGpk="
+  "fingerprint": "9L8/rsLS+UYbDYN+YX0Wb3gybgQNUCyFdD52GKTWEs0="
 }
diff --git a/packages/jsii-diff/package-lock.json b/packages/jsii-diff/package-lock.json
diff --git a/packages/jsii-dotnet-jsonmodel/package-lock.json b/packages/jsii-dotnet-jsonmodel/package-lock.json
diff --git a/packages/jsii-dotnet-runtime-test/package-lock.json b/packages/jsii-dotnet-runtime-test/package-lock.json
diff --git a/packages/jsii-dotnet-runtime/package-lock.json b/packages/jsii-dotnet-runtime/package-lock.json
diff --git a/packages/jsii-java-runtime/package-lock.json b/packages/jsii-java-runtime/package-lock.json
diff --git a/packages/jsii-kernel/package-lock.json b/packages/jsii-kernel/package-lock.json
diff --git a/packages/jsii-pacmak/lib/targets/java.ts b/packages/jsii-pacmak/lib/targets/java.ts
@@ -365,7 +365,7 @@ class JavaGenerator extends Generator {
         this.code.line('/**');
         if (mod.readme) {
             for (const line of md2html(mod.readme.markdown).split('\n')) {
-                this.code.line(` * ${line}`);
+                this.code.line(` * ${line.replace(/\*\//g, '*{@literal /}')}`);
             }
         }
         if (mod.docs.deprecated) {

diff --git a/packages/jsii-pacmak/package-lock.json b/packages/jsii-pacmak/package-lock.json
diff --git a/...es/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii b/...es/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii
@@ -197,7 +197,7 @@
   },
   "name": "jsii-calc",
   "readme": {
-    "markdown": "# jsii Calculator\n\nThis library is used to demonstrate and test the features of JSII\n\n## Sphinx\n\nThis file will be incorporated into the sphinx documentation.\n\nIf this file starts with an \"H1\" line (in our case `# jsii Calculator`), this\nheading will be used as the Sphinx topic name. Otherwise, the name of the module\n(`jsii-calc`) will be used instead.\n\n\n\n\n"
+    "markdown": "# jsii Calculator\n\nThis library is used to demonstrate and test the features of JSII\n\n## Sphinx\n\nThis file will be incorporated into the sphinx documentation.\n\nIf this file starts with an \"H1\" line (in our case `# jsii Calculator`), this\nheading will be used as the Sphinx topic name. Otherwise, the name of the module\n(`jsii-calc`) will be used instead.\n\n## Code Samples\n\n```ts\n/* This is totes a magic comment in here, just you wait! */\nconst foo = 'bar';\n```\n"
   },
   "repository": {
     "type": "git",
@@ -8604,5 +8604,5 @@
     }
   },
   "version": "0.11.1",
-  "fingerprint": "uCNbkp5+1duLs9lW2h4C+T4dTtV6ZArNhzgT39ChGpk="
+  "fingerprint": "9L8/rsLS+UYbDYN+YX0Wb3gybgQNUCyFdD52GKTWEs0="
 }
diff --git a/...cted.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/package-info.java b/...cted.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/package-info.java
@@ -6,6 +6,10 @@
  * <p>If this file starts with an &quot;H1&quot; line (in our case <code># jsii Calculator</code>), this
  * heading will be used as the Sphinx topic name. Otherwise, the name of the module
  * (<code>jsii-calc</code>) will be used instead.</p>
+ * <h2>Code Samples</h2>
+ * <pre><code class="language-ts">/* This is totes a magic comment in here, just you wait! *{@literal /}
+ * const foo = 'bar';
+ * </code></pre>
  * 
  */
 @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)

diff --git a/packages/jsii-pacmak/test/expected.jsii-calc/python/README.md b/packages/jsii-pacmak/test/expected.jsii-calc/python/README.md
@@ -10,7 +10,10 @@ If this file starts with an "H1" line (in our case `# jsii Calculator`), this
 heading will be used as the Sphinx topic name. Otherwise, the name of the module
 (`jsii-calc`) will be used instead.
 
+## Code Samples
 
-
-
+```ts
+/* This is totes a magic comment in here, just you wait! */
+const foo = 'bar';
+```
 
diff --git a/packages/jsii-pacmak/test/expected.jsii-calc/sphinx/_jsii-calc.README.md b/packages/jsii-pacmak/test/expected.jsii-calc/sphinx/_jsii-calc.README.md
@@ -9,7 +9,10 @@ If this file starts with an "H1" line (in our case `# jsii Calculator`), this
 heading will be used as the Sphinx topic name. Otherwise, the name of the module
 (`jsii-calc`) will be used instead.
 
+## Code Samples
 
-
-
+```ts
+/* This is totes a magic comment in here, just you wait! */
+const foo = 'bar';
+```
 
diff --git a/packages/jsii-reflect/package-lock.json b/packages/jsii-reflect/package-lock.json
diff --git a/packages/jsii-ruby-runtime/package-lock.json b/packages/jsii-ruby-runtime/package-lock.json
diff --git a/packages/jsii-runtime/package-lock.json b/packages/jsii-runtime/package-lock.json
diff --git a/packages/jsii-spec/package-lock.json b/packages/jsii-spec/package-lock.json
diff --git a/packages/jsii/package-lock.json b/packages/jsii/package-lock.json
diff --git a/packages/oo-ascii-tree/package-lock.json b/packages/oo-ascii-tree/package-lock.json