Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade maven-javadoc-plugin; fix a few javadoc warnings #764

Merged
merged 1 commit into from Feb 26, 2020

Conversation

daveyarwood
Copy link
Contributor

As I was releasing 0.5.2, I noticed some javadoc warnings:

[INFO] Note: Custom tags that could override future standard tags:  @apiNote. To avoid potential overrides, use at least one period character (.) in custom tag names.
[INFO] 7 warnings
[INFO] [WARNING] Javadoc Warnings
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/org/zeromq/ZMQ.java:833: warning - Tag @link: can't find Socket(Context, SocketType) in org.zeromq.ZMQ.Socket
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/org/zeromq/ZMQ.java:2213: warning - @param argument "chooser," is not a parameter name.
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/org/zeromq/ZStar.java:169: warning - Tag @link: can't find create(ZContext, Socket, int, Star, Object...) in org.zeromq.ZStar.Fortune
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/org/zeromq/proto/ZPicture.java:183: warning - Tag @link: can't find sendBinaryPicture(Socket, String, Object...) in org.zeromq.proto.ZPicture
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/org/zeromq/proto/ZPicture.java:280: warning - Tag @link: can't find recvPicture(Socket, String) in org.zeromq.proto.ZPicture
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/org/zeromq/proto/ZPicture.java:370: warning - Tag @link: can't find sendPicture(Socket, String, Object...) in org.zeromq.proto.ZPicture
[INFO] [WARNING] /home/dave/code/jeromq/target/checkout/src/main/java/zmq/io/net/tcp/TcpAddress.java:92: warning - @return tag has no arguments.

This fixes a few of those.

I wasn't able to make sense of the @link warnings. I tried a bunch of different syntaxes, and nothing seems to get rid of the warning. I barely understand what I'm doing, so maybe someone else will have more luck. :)

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.2%) to 85.169% when pulling 8a79f57 on daveyarwood:javadoc-fixes into 0e53911 on zeromq:master.

@coveralls
Copy link

coveralls commented Feb 1, 2020

Coverage Status

Coverage decreased (-0.06%) to 85.294% when pulling 8a79f57 on daveyarwood:javadoc-fixes into 0e53911 on zeromq:master.

@daveyarwood daveyarwood merged commit 06ea1a4 into zeromq:master Feb 26, 2020
@daveyarwood daveyarwood deleted the javadoc-fixes branch February 26, 2020 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants