Merge pull request #764 from daveyarwood/javadoc-fixes

Upgrade maven-javadoc-plugin; fix a few javadoc warnings
zeromq · Feb 26, 2020 · 06ea1a4 · 06ea1a4
2 parents 0e53911 + 8a79f57
commit 06ea1a4
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/pom.xml b/pom.xml
@@ -203,13 +203,13 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
-          <version>3.0.1</version>
+          <version>3.1.1</version>
           <configuration>
             <keywords>true</keywords>
             <source>1.8</source>
             <tags>
               <tag>
-                <name>apiNote</name>
+                <name>api.note</name>
                 <placement>a</placement>
                 <head>API Note</head>
               </tag>

diff --git a/src/main/java/org/zeromq/ZMQ.java b/src/main/java/org/zeromq/ZMQ.java
@@ -2207,7 +2207,7 @@ public boolean setMsgAllocator(MsgAllocator allocator)
         /**
          * Set a custom {@link java.nio.channels.spi.SelectorProvider} chooser.
          *
-         * @param chooser, the custom chooser.
+         * @param chooser the custom chooser.
          * @return true if the option was set, otherwise false.
          */
         public boolean setSelectorChooser(SelectorProviderChooser chooser)
@@ -3334,7 +3334,7 @@ public boolean sendPicture(String picture, Object... args)
          * @param args    Arguments according to the picture
          * @return true when it has been queued on the socket and ØMQ has assumed responsibility for the message.
          * This does not indicate that the message has been transmitted to the network.
-         * @apiNote Does not change or take ownership of any arguments.
+         * @api.note Does not change or take ownership of any arguments.
          */
         @Draft
         public boolean sendBinaryPicture(String picture, Object... args)

diff --git a/src/main/java/org/zeromq/proto/ZPicture.java b/src/main/java/org/zeromq/proto/ZPicture.java
@@ -46,7 +46,7 @@ public class ZPicture
      * @param args    Arguments according to the picture
      * @return true when it has been queued on the socket and ØMQ has assumed responsibility for the message.
      * This does not indicate that the message has been transmitted to the network.
-     * @apiNote Does not change or take ownership of any arguments.
+     * @api.note Does not change or take ownership of any arguments.
      */
     @Draft
     public ZMsg msgBinaryPicture(String picture, Object... args)

diff --git a/src/main/java/zmq/io/net/tcp/TcpAddress.java b/src/main/java/zmq/io/net/tcp/TcpAddress.java
@@ -85,7 +85,7 @@ public String toString(int port)
      * @param name
      * @param ipv6
      * @param local ignored
-     * @return
+     * @return the resolved address
      * @see zmq.io.net.Address.IZAddress#resolve(java.lang.String, boolean, boolean)
      */
     @Override