You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Lukas Theussl (JIRA)" <ji...@codehaus.org> on 2005/11/10 20:09:06 UTC

[jira] Closed: (MPHTMLXDOC-5) Documentation is wrong/misleading

     [ http://jira.codehaus.org/browse/MPHTMLXDOC-5?page=all ]
     
Lukas Theussl closed MPHTMLXDOC-5:
----------------------------------

    Resolution: Fixed

Documentation updated.

> Documentation is wrong/misleading
> ---------------------------------
>
>          Key: MPHTMLXDOC-5
>          URL: http://jira.codehaus.org/browse/MPHTMLXDOC-5
>      Project: maven-html2xdoc-plugin
>         Type: Improvement
>  Environment: All
>     Reporter: Chuck Daniels
>     Assignee: Lukas Theussl
>      Fix For: 1.4

>
>
> The documentation for the plugin has a few problems that lead to confusion:
> 1. The "About" page indicates that the following must be added to maven.xml:
>   <preGoal name="xdoc:jelly-transform">
>     <attainGoal name="html2xdoc"/>
>   </preGoal>
> When in fact, this is not necessary, as setting maven.html2xdoc.enabled to true will cause the html2xdoc goal to be attained automatically. (As an aside, however, I am going to log another issue stating that the above is preferred to using an xdoc:init preGoal, as is done within the plugin. As an xdoc:init preGoal, the html2xdoc goal is executed 3 times during execution of the site goal. This is unacceptable for large documentation sets).
> 2. The property maven.html2xdoc.jsl is documented, but unused. It has no affect. It should be removed from the documentation.

-- 
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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org