You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nutch.apache.org by "Furkan KAMACI (JIRA)" <ji...@apache.org> on 2016/05/20 00:01:21 UTC

[jira] [Comment Edited] (NUTCH-2122) Implement Javadoc package.html for webui packages

    [ https://issues.apache.org/jira/browse/NUTCH-2122?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15292388#comment-15292388 ] 

Furkan KAMACI edited comment on NUTCH-2122 at 5/19/16 11:59 PM:
----------------------------------------------------------------

[~lewismc] we may also prefer package-info.java to package.html. [Oracle documentation|http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#packagecomment] says that:

{quote}
package-info.java - Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is generally preferred over package.html.
package.html - Can contain only package comments and Javadoc tags, no package annotations.
{quote}

For more information check [this|http://stackoverflow.com/questions/3644726/javadoc-package-html-or-package-info-java].


was (Author: kamaci):
[~lewismc] we may also prefer package-info.java to package.html. [Oracle documentation|http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#packagecomment] says that:

{quote}
package-info.java - Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is generally preferred over package.html.
package.html - Can contain only package comments and Javadoc tags, no package annotations.
{quote}

> Implement Javadoc package.html for webui packages
> -------------------------------------------------
>
>                 Key: NUTCH-2122
>                 URL: https://issues.apache.org/jira/browse/NUTCH-2122
>             Project: Nutch
>          Issue Type: Improvement
>          Components: nutch server
>    Affects Versions: 1.10
>            Reporter: Lewis John McGibbney
>            Priority: Trivial
>             Fix For: 1.13
>
>
> [~sujenshah] I noticed that the Javadoc does not contain package.html displaying package level introductory Javadoc as every other package does.
> http://nutch.apache.org/apidocs/apidocs-1.10/index.html



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)