Add javadoc section in proxy/pom.xml.

Fix javadoc errors in proxy.
aerospike · Aug 2, 2023 · 37d2f2f · 37d2f2f
1 parent 669069f
commit 37d2f2f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 7 deletions.
diff --git a/proxy/pom.xml b/proxy/pom.xml
@@ -102,6 +102,29 @@
           </execution>
         </executions>
       </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <configuration>
+          <source>8</source>
+          <doclint>none</doclint>
+          <reportOutputDirectory>${basedir}</reportOutputDirectory>
+          <doctitle>Aerospike Java Proxy Client</doctitle>
+          <show>public</show>
+          <splitindex>true</splitindex>
+          <bottom>Copyright &#169; 2012&#x2013;{currentYear} Aerospike, Inc. All rights reserved.</bottom>
+          <sourcepath>${basedir}/src</sourcepath>
+          <sourceFileIncludes>
+            <include>com/aerospike/client/proxy/AerospikeClientFactory.java</include>
+            <include>com/aerospike/client/proxy/AerospikeClientProxy.java</include>
+            <include>com/aerospike/client/proxy/RecordProxy.java</include>
+            <include>com/aerospike/client/proxy/RecordSequenceRecordSet.java</include>
+            <include>com/aerospike/client/proxy/ResultSetProxy.java</include>
+          </sourceFileIncludes>
+        </configuration>
+      </plugin>
+
     </plugins>
   </build>
 </project>
diff --git a/proxy/src/com/aerospike/client/proxy/grpc/GrpcClientPolicy.java b/proxy/src/com/aerospike/client/proxy/grpc/GrpcClientPolicy.java
@@ -86,8 +86,8 @@ public class GrpcClientPolicy {
 	 * like Aerospike get, put, operate, etc to improve latency and throughput.
 	 * <code>maxConcurrentRequestsPerStream</code> specifies the number of
 	 * concurrent requests that can be sent on a single unary call based stream.
-	 * <p/>
-	 * <bold>NOTE</bold> This policy does not apply to queries, scans, etc.
+	 * <p>
+	 * NOTE: This policy does not apply to queries, scans, etc.
 	 */
 	public final int maxConcurrentRequestsPerStream;
 
@@ -106,8 +106,8 @@ public class GrpcClientPolicy {
 	 * servers, but it will send all requests on a HTTP/2 stream to a single
 	 * gRPC Aerospike proxy server. This policy ensures that the requests are
 	 * evenly load balanced across the gRPC Aerospike proxy servers.
-	 * <p/>
-	 * <bold>NOTE</bold> This policy does not apply to queries, scans, etc.
+	 * <p>
+	 * NOTE: This policy does not apply to queries, scans, etc.
 	 */
 	public final int totalRequestsPerStream;
 
@@ -141,8 +141,7 @@ public class GrpcClientPolicy {
 	/**
 	 * The TLS policy to connect to the gRPC Aerospike proxy server.
 	 * <p>
-	 * <bold>NOTE</bold> The channel (connection) will  be non-encrypted if
-	 * this policy is <code>null</code>.
+	 * NOTE: The channel (connection) will  be non-encrypted if this policy is <code>null</code>.
 	 */
 	@Nullable
 	public final TlsPolicy tlsPolicy;

diff --git a/proxy/src/com/aerospike/client/proxy/grpc/GrpcStream.java b/proxy/src/com/aerospike/client/proxy/grpc/GrpcStream.java
@@ -46,7 +46,6 @@
  *     <li>have the channel and streams associated with the channel be
  *     executed on a single event loop</li>
  * </ul>
- * <p>
  */
 public class GrpcStream implements StreamObserver<Kvs.AerospikeResponsePayload> {
 	/**