[
https://issues.apache.org/jira/browse/ZOOKEEPER-2862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16113217#comment-16113217
]
ASF GitHub Bot commented on ZOOKEEPER-2862:
-------------------------------------------
GitHub user hanm opened a pull request:
https://github.com/apache/zookeeper/pull/326
ZOOKEEPER-2862: Incorrect javadoc syntax for web links in
StaticHostProvider.java.
Javadoc does not offer any special tagging for web links - the "@link" etc
is for linking with other javadocs of the classes / methods. Use normal html
markup instead.
This fixes warning messages generated when running "ant javadoc". Verified
generated javadoc that the web link is functional.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/hanm/zookeeper ZOOKEEPER-2862
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zookeeper/pull/326.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #326
----
commit d7f662e584729be11e0570121a0bab3cc899639b
Author: Michael Han <[email protected]>
Date: 2017-08-03T18:05:16Z
ZOOKEEPER-2862: Incorrect javadoc syntax for web links in
StatisHostProvider.java.
----
> Incorrect javadoc syntax for web links in StaticHostProvider.java
> -----------------------------------------------------------------
>
> Key: ZOOKEEPER-2862
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2862
> Project: ZooKeeper
> Issue Type: Bug
> Components: documentation, java client
> Reporter: Michael Han
> Assignee: Michael Han
> Labels: javadoc
>
> {{StaticHostProvider#updateServerList}} uses wrong syntax to embed https link
> in the java doc. Previously this issue was not visible because
> StaticHostProvider was not public of public java doc; after ZOOKEEPER-2829
> {{StaticHostProvider}} is now part of API doc and incorrect syntax leads to
> java doc warnings, which creates noises in Jenkins pre-commit jobs.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
