Update operator-annotations/src/main/java/io/javaoperatorsdk/processor/SampleProcessor.java

csviri · Copilot · csviri · commit 58b4776a5513 · 2025-11-20T15:05:58.000+01:00
Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/operator-annotations/src/main/java/io/javaoperatorsdk/processor/SampleProcessor.java b/operator-annotations/src/main/java/io/javaoperatorsdk/processor/SampleProcessor.java
@@ -53,7 +53,11 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
     }
 
     /**
+     * Writes a markdown file named {@code samples.md} listing all provided samples.
+     * Each sample is written as a section with its TLDR and description.
      *
+     * @param samples the list of samples to include in the markdown file
+     * @throws RuntimeException if an I/O error occurs during file writing
      */
     private void writeSampleMDFile(List<SampleInfo> samples) {
         try {

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,11 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
	`56`	`+ * Writes a markdown file named {@code samples.md} listing all provided samples.`
	`57`	`+ * Each sample is written as a section with its TLDR and description.`
`56`	`58`	`*`
	`59`	`+ * @param samples the list of samples to include in the markdown file`
	`60`	`+ * @throws RuntimeException if an I/O error occurs during file writing`
`57`	`61`	`*/`
`58`	`62`	`private void writeSampleMDFile(List<SampleInfo> samples) {`
`59`	`63`	`try {`