fix: use single-line comments for SNIP markers to avoid NotJavadoc warnings (#765)

mfateev · web-flow · commit dfef8ac2652c · 2026-01-12T09:49:13.000-05:00
ErrorProne's NotJavadoc check flags `/**` block comments that aren't
actual Javadoc. The SNIP markers are for documentation extraction,
not Javadoc, so use `//` single-line comments instead.

Co-authored-by: Maxim Fateev &lt;1463622+mfateev@users.noreply.github.com&gt;
diff --git a/core/src/main/java/io/temporal/samples/envconfig/LoadFromFile.java b/core/src/main/java/io/temporal/samples/envconfig/LoadFromFile.java
@@ -1,8 +1,6 @@
 package io.temporal.samples.envconfig;
 
-/**
- * @@@SNIPSTART java-env-config-profile
- */
+// @@@SNIPSTART java-env-config-profile
 import io.temporal.client.WorkflowClient;
 import io.temporal.client.WorkflowClientOptions;
 import io.temporal.envconfig.ClientConfigProfile;
@@ -80,6 +78,4 @@ public static void main(String[] args) {
     }
   }
 }
-/**
- * @@@SNIPEND
- */
+// @@@SNIPEND
diff --git a/core/src/main/java/io/temporal/samples/envconfig/LoadProfile.java b/core/src/main/java/io/temporal/samples/envconfig/LoadProfile.java
@@ -1,8 +1,6 @@
 package io.temporal.samples.envconfig;
 
-/**
- * @@@SNIPSTART java-env-config-profile-with-overrides
- */
+// @@@SNIPSTART java-env-config-profile-with-overrides
 import io.temporal.client.WorkflowClient;
 import io.temporal.client.WorkflowClientOptions;
 import io.temporal.envconfig.ClientConfigProfile;
@@ -88,6 +86,4 @@ public static void main(String[] args) {
     }
   }
 }
-/**
- * @@@SNIPEND
- */
+// @@@SNIPEND

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`package io.temporal.samples.envconfig;`
`2`	`2`
`3`		`-/**`
`4`		`- * @@@SNIPSTART java-env-config-profile`
`5`		`- */`
	`3`	`+// @@@SNIPSTART java-env-config-profile`
`6`	`4`	`import io.temporal.client.WorkflowClient;`
`7`	`5`	`import io.temporal.client.WorkflowClientOptions;`
`8`	`6`	`import io.temporal.envconfig.ClientConfigProfile;`
`@@ -80,6 +78,4 @@ public static void main(String[] args) {`
`80`	`78`	`}`
`81`	`79`	`}`
`82`	`80`	`}`
`83`		`-/**`
`84`		`- * @@@SNIPEND`
`85`		`- */`
	`81`	`+// @@@SNIPEND`