maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gregory Kick (JIRA)" <j...@codehaus.org>
Subject [jira] Commented: (MCHECKSTYLE-64) Allow inclusion of javadoc source path in check
Date Sat, 31 Mar 2007 21:39:19 GMT

    [ http://jira.codehaus.org/browse/MCHECKSTYLE-64?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_91697
] 

Gregory Kick commented on MCHECKSTYLE-64:
-----------------------------------------

I've looked into this and it's actually an issue with the {{PackageHtmlCheck}}.  Rather than
checking the fileset to see that it includes a corresponding {{package.html}}, it creates
a {{File}} for {{package.html}} in the same directory as the java file and uses the {{exists()}}
method.  In order for this issue to be resolved, it would require either a fix in checkstyle
or a new check implemented specifically for maven.  In the end, I like to do things the _maven
way_, but  in this particular case, I'm not entirely sure that putting {{package.html}} files
in a different directory even makes sense anyway.  Why put just a small fraction of the javadocs
in a different folder?  It is a little odd to put resources like images there, but the {{package.html}}
files just might be better off in {{src/main/java}}.

> Allow inclusion of javadoc source path in check
> -----------------------------------------------
>
>                 Key: MCHECKSTYLE-64
>                 URL: http://jira.codehaus.org/browse/MCHECKSTYLE-64
>             Project: Maven 2.x Checkstyle Plugin
>          Issue Type: Improvement
>    Affects Versions: 2.1
>            Reporter: Johan Vanbockryck
>            Priority: Minor
>
> According to the documentation of the maven-javadoc-plugin, the Javadoc resources (like
package.html) should be placed in src/main/javadoc. This will cause a checkstyle error for
missing package.html files however when enabling the PackageHtml module, since this directory
is not included in the checkstyle source path.
> See also: http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message