Merge pull request #13 from phillip-kruger/javadoc

Javadoc

pom.xml

@@ -50,7 +50,7 @@
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
         <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
-        <quarkus.platform.version>3.13.3</quarkus.platform.version>
+        <quarkus.platform.version>3.14.1</quarkus.platform.version>
         <skipITs>true</skipITs>
         <surefire-plugin.version>3.2.5</surefire-plugin.version>
 

src/main/java/org/chappiebot/doc/DocAssistant.java

@@ -0,0 +1,34 @@
+package org.chappiebot.doc;
+
+import dev.langchain4j.service.SystemMessage;
+import dev.langchain4j.service.UserMessage;
+import io.quarkiverse.langchain4j.RegisterAiService;
+
+@RegisterAiService
+@SystemMessage("""
+                You are an AI assistant helping to add or modify {doc} in {programmingLanguage} code from a {product} {version} application.
+                You will receive the code that needs the {doc}. Please use that as input when considering the response.
+
+                Approach this task step-by-step, take your time and do not skip steps.
+               
+                Respond with the original input source code, but now enhance with the {doc} on class and method levels. 
+                This response must be valid {programmingLanguage}. Only include the {programmingLanguage} code, no explanation or other text. 
+                
+                You must not wrap {programmingLanguage} response in backticks, markdown, or in any other way, but return it as plain text.
+                
+            """)
+public interface DocAssistant {
+
+    @UserMessage("""
+                I have the following {programmingLanguage} class:
+                ```
+                {source}
+                ```
+                
+                {extraContext}
+                 
+                Please add or modify the {doc} to reflect the code.
+            """)
+    public String addDoc(String programmingLanguage, String product, String version, String extraContext, String doc, String source);
+
+}

src/main/java/org/chappiebot/doc/DocEndpoint.java

@@ -0,0 +1,24 @@
+package org.chappiebot.doc;
+
+import io.quarkiverse.jsonrpc.runtime.api.JsonRPCApi;
+import jakarta.inject.Inject;
+
+/**
+ * The JsonRPC Endpoint for doc creation
+ * @author Phillip Kruger (phillip.kruger@gmail.com)
+ */
+@JsonRPCApi("doc")
+public class DocEndpoint {
+
+    @Inject DocAssistant docAssistant;
+
+    public String addDoc(String programmingLanguage, 
+                                    String product, 
+                                    String version,
+                                    String extraContext,
+                                    String doc,
+                                    String source) {
+
+        return docAssistant.addDoc(programmingLanguage, product, version, extraContext, doc, source);
+    }
+}

src/main/java/org/chappiebot/test/TestAssistant.java

@@ -7,8 +7,7 @@
 @RegisterAiService
 @SystemMessage("""
                 You are an AI assistant helping to create Unit tests in {programmingLanguage} code from a {product} {version} application.
-                You will receive the code that needs a test. 
-                Please use that as input when considering the response.
+                You will receive the code that needs a test. Please use that as input when considering the response.
 
                 Approach this task step-by-step, take your time and do not skip steps.
                

src/main/java/org/chappiebot/test/TestEndpoint.java

@@ -2,7 +2,7 @@
 
 import io.quarkiverse.jsonrpc.runtime.api.JsonRPCApi;
 import jakarta.inject.Inject;
-import java.util.List;
+
 /**
  * The JsonRPC Endpoint for test creation
  * @author Phillip Kruger (phillip.kruger@gmail.com)