update javadoc

HHS · Jul 9, 2024 · 7e78de6 · 7e78de6
1 parent 23cdff8
commit 7e78de6
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/core/src/main/java/gov/hhs/aspr/ms/taskit/core/engine/ITaskitEngine.java b/core/src/main/java/gov/hhs/aspr/ms/taskit/core/engine/ITaskitEngine.java
@@ -136,7 +136,7 @@ public <C, O extends C> void translateAndWrite(Path path, O object, Class<C> cla
      * this conversion method will be used approx ~3% of the time
      * </p>
      * 
-     * @param <T>      the corresponding type
+     * @param <T>      the translated type
      * @param <O>      the type of the object
      * @param <C>      the type to translate the object as
      * @param object   the object to translate

diff --git a/pom.xml b/pom.xml
@@ -313,6 +313,14 @@
                                 <additionalJOption>-Xmaxwarns</additionalJOption>
                                 <additionalJOption>65536</additionalJOption>
                             </additionalJOptions>
+                            <tags>
+                                <tag>
+                                    <name>implNote</name>
+                                    <placement>a</placement>
+                                    <head>Implementation Note:</head>
+                                </tag>
+                            </tags>
+                            <sourcepath>${project.build.sourceDirectory}</sourcepath>
                         </configuration>
                         <executions>
                             <execution>

diff --git a/protobuf/pom.xml b/protobuf/pom.xml
@@ -191,5 +191,20 @@
                 </plugins>
             </build>
         </profile>
+        <profile>
+            <id>javadoc</id>
+            <build>
+                <plugins>
+                    <!--Attaches javadoc jar to project -->
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-javadoc-plugin</artifactId>
+                        <configuration>
+                            <sourcepath>${project.build.sourceDirectory}:${project.build.directory}/generated-sources/protobuf/java</sourcepath>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
     </profiles>
 </project>