feat: add examples for adding parameters flag

Incendo · Aug 22, 2024 · a9d44a9 · a9d44a9
1 parent 7a905fb
commit a9d44a9
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 0 deletions.
diff --git a/docs/annotations/index.md b/docs/annotations/index.md
@@ -25,6 +25,10 @@ Cloud Annotations is available through [Maven Central](https://central.sonatype.
 
 {{ dependency_listing("annotations", "core") }}
 
+In order to for Cloud to obtain the parameter names for arguments you'll need to add the parameter flag to your Java/Kotlin compilation step.
+
+{{ javac_parameters() }}
+
 You then need to create an
 {{ javadoc("https://javadoc.io/doc/org.incendo/cloud-annotations/latest/org/incendo/cloud/annotations/AnnotationParser.html", "AnnotationParser") }}
 instance.

diff --git a/main.py b/main.py
@@ -101,6 +101,79 @@ def shade_dependency() -> str:
     ```
 """
 
+    @env.macro
+    def javac_parameters() -> str:
+        return """
+=== "Maven"
+    
+    ```xml
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+                <configuration>
+                    <compilerArgs>
+                        <arg>-parameters</arg>
+                    </compilerArgs>
+                </configuration>
+            </plugin>
+
+            <!-- For kotlin plugins -->
+            <plugin>
+                <groupId>org.jetbrains.kotlin</groupId>
+                <artifactId>kotlin-maven-plugin</artifactId>
+                <version>1.9.0</version> <!-- Replace with your Kotlin version -->
+                <executions>
+                    <execution>
+                        <id>compile</id>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                        <configuration>
+                            <args>
+                                <arg>-java-parameters</arg>
+                            </args>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    ```
+
+=== "Gradle (Kotlin)"
+
+    ```kotlin
+    tasks.withType<JavaCompile> {
+        options.compilerArgs.add("-parameters")
+    }
+
+    // only needed if your project uses Kotlin
+    tasks.withType<KotlinCompile> {
+        compilerOptions {
+            freeCompilerArgs.add("-java-parameters")
+        }
+    }
+    ```
+
+=== "Gradle (Groovy)"
+
+    ```groovy
+    tasks.withType(JavaCompile) {
+        options.compilerArgs << "-parameters"
+    }
+
+    // only needed if your project uses Kotlin
+    tasks.withType(KotlinCompile) {
+        kotlinOptions {
+            freeCompilerArgs << "-java-parameters"
+        }
+    }
+    ```
+"""
+
     @env.macro
     def javadoc(link: str, title: str = None) -> str:
         if title is None: