We should strive to create clean Javadocs that pass doclint. See also https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html?m=1
Gary On Tue, Jun 16, 2020, 12:07 sebb <seb...@gmail.com> wrote: > On Tue, 16 Jun 2020 at 16:57, Xeno Amess <xenoam...@gmail.com> wrote: > > > > > Is Javadoc HTML? > > yep it is. > > But like I said I hate HTML for allowing people not to close tags. > > In many ways I'd prefer XHTML. > > > > > Fixing the tags will be a lot of work. > > Actually not that lot... > > Give me several hours and I can clean them all... > > This will generate a lot of commit changes that have to be reviewed. > > > But I'd prefer listening about others' opinions first. > > Is there any other guy who wanna join this chat & give some opinions? > > > > > > sebb <seb...@gmail.com> 于2020年6月16日周二 下午11:39写道： > > > > > On Tue, 16 Jun 2020 at 16:28, Xeno Amess <xenoam...@gmail.com> wrote: > > > > > > > > It really can according to html. > > > > But -1 for doing so. > > > > btw that is why I hate html. > > > > > > Is Javadoc HTML? > > > > > > AFAIK there are a lot of Commons Javadoc with unclosed <p> tags. > > > > > > So long as the generated docs look OK, I don't see any reason to spend > > > any time adding closing tags. Fixing the tags will be a lot of work. > > > > > > For example, I counted the following: > > > > > > IO: > > > <p> 733 > > > </p> 264 > > > > > > NET: > > > <p> 543 > > > <p> 59 > > > > > > > sebb <seb...@gmail.com> 于2020年6月16日周二 下午11:25写道： > > > > > > > > > On Tue, 16 Jun 2020 at 14:28, Gary Gregory <garydgreg...@gmail.com > > > > > wrote: > > > > > > > > > > > > On Tue, Jun 16, 2020 at 8:53 AM <s...@apache.org> wrote: > > > > > > > > > > > > > This is an automated email from the ASF dual-hosted git > repository. > > > > > > > > > > > > > > sebb pushed a commit to branch master > > > > > > > in repository > https://gitbox.apache.org/repos/asf/commons-net.git > > > > > > > > > > > > > > > > > > > > > The following commit(s) were added to refs/heads/master by this > > > push: > > > > > > > new 32f8d54 Fix Javadoc complaint > > > > > > > 32f8d54 is described below > > > > > > > > > > > > > > commit 32f8d5430225d5fcf2e9b3dbcb7f8ef9455df15b > > > > > > > Author: Sebb <s...@apache.org> > > > > > > > AuthorDate: Tue Jun 16 13:53:18 2020 +0100 > > > > > > > > > > > > > > Fix Javadoc complaint > > > > > > > --- > > > > > > > src/main/java/org/apache/commons/net/ftp/FTPClient.java | 2 +- > > > > > > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > > > > > > > > > > > diff --git > > > a/src/main/java/org/apache/commons/net/ftp/FTPClient.java > > > > > > > b/src/main/java/org/apache/commons/net/ftp/FTPClient.java > > > > > > > index 94cd7ff..964ae7f 100644 > > > > > > > --- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java > > > > > > > +++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java > > > > > > > @@ -278,7 +278,7 @@ import org.apache.commons.net.io.Util; > > > > > > > * method, so the timing is partially dependent on how long > each > > > block > > > > > > > transfer takes. > > > > > > > * <p> > > > > > > > * <b>This keep-alive feature is optional; if it does not > help or > > > > > causes > > > > > > > problems then don't use it.</b> > > > > > > > - * <p> > > > > > > > + * > > > > > > > > > > > > > > > > > > > That's not right either: HTML tags should _closed_ > > > > > > > > > > <p> closing tags can be omitted according to: > > > > > > > > > > https://www.w3.org/TR/html401/intro/sgmltut.html#h-3.2.1 > > > > > > > > > > > > > > > > gARY > > > > > > > > > > > > > * @see #FTP_SYSTEM_TYPE > > > > > > > * @see #SYSTEM_TYPE_PROPERTIES > > > > > > > * @see FTP > > > > > > > > > > > > > > > > > > > > > > > > > --------------------------------------------------------------------- > > > > > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > > > > > For additional commands, e-mail: dev-h...@commons.apache.org > > > > > > > > > > > > > > > > --------------------------------------------------------------------- > > > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > > > For additional commands, e-mail: dev-h...@commons.apache.org > > > > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > >
