commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gilles (Reopened) (JIRA)" <j...@apache.org>
Subject [jira] [Reopened] (MATH-445) Replace "package.html" by "package-info.java"
Date Sun, 02 Oct 2011 01:54:34 GMT

     [ https://issues.apache.org/jira/browse/MATH-445?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Gilles reopened MATH-445:
-------------------------


Missing "package.html" now trigger a CheckStyle complaint.

I tried to replace the old rule with
{noformat}
  <module name="JavadocPackage"/>
{noformat}
(as documented [here|http://checkstyle.sourceforge.net/config_javadoc.html]), but this prevents
the plugin to work correctly:
{noformat}
[INFO] Generating "Checkstyle" report.
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error during page generation

Embedded error: Error rendering Maven report: Failed during checkstyle configuration
Unable to instantiate JavadocPackageCheck
{noformat}
Maybe that the plugin version is too old (?).
                
> Replace "package.html" by "package-info.java"
> ---------------------------------------------
>
>                 Key: MATH-445
>                 URL: https://issues.apache.org/jira/browse/MATH-445
>             Project: Commons Math
>          Issue Type: Task
>            Reporter: Gilles
>            Priority: Trivial
>             Fix For: 3.0
>
>
> The newest (and recommended, I think) way of documenting packages is through "package-info.java"
files.
> CM still uses "package.html" files.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message