You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "David J. M. Karlsen (JIRA)" <ji...@codehaus.org> on 2008/09/10 23:49:48 UTC

[jira] Created: (MDOCCK-14) Plugin does not respect generated documentation

Plugin does not respect generated documentation
-----------------------------------------------

                 Key: MDOCCK-14
                 URL: http://jira.codehaus.org/browse/MDOCCK-14
             Project: Maven 2.x Documentation Checker Plugin
          Issue Type: Bug
    Affects Versions: 1.0-beta-2
         Environment: N/A
            Reporter: David J. M. Karlsen


The plugin does not respect generated content (from velocity templates), for example the project at:
http://svn.codehaus.org/mojo/trunk/mojo/was6-maven-plugin/

generates completely valid documentation - but the plugin fails with:

[INFO] [docck:check {execution: verify}]
[INFO] Checking project: WAS6 Maven Plugin
[INFO] Using 2 extractors.
[INFO] Applying extractor for language: java
[INFO] Extractor for language: java found 12 mojo descriptors.
[INFO] Applying extractor for language: bsh
[INFO] Extractor for language: bsh found 0 mojo descriptors.
[ERROR] The following documentation problems were found:

o WAS6 Maven Plugin (3 errors, 0 warnings)
  [ERROR] There is no 'usage' file in your site directory (in apt|html|xml format).
  [ERROR] There are no example files in your site directory (in apt|html|xml format). They should either be called 'example*.(apt|html|xml)' or they should be located in the 'examples' directory.
  [ERROR] There is no 'faq' file in your site directory (in apt|fml|html|xml format).



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

        

[jira] Commented: (MDOCCK-14) Plugin does not respect generated documentation

Posted by "David J. M. Karlsen (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MDOCCK-14?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=147679#action_147679 ] 

David J. M. Karlsen commented on MDOCCK-14:
-------------------------------------------

Oh - I went through the issues but didn't notice that one - could 1.0-beta-3 be released soon - it's been over a year since last rel.

> Plugin does not respect generated documentation
> -----------------------------------------------
>
>                 Key: MDOCCK-14
>                 URL: http://jira.codehaus.org/browse/MDOCCK-14
>             Project: Maven 2.x Documentation Checker Plugin
>          Issue Type: Bug
>    Affects Versions: 1.0-beta-2
>         Environment: N/A
>            Reporter: David J. M. Karlsen
>            Assignee: Benjamin Bentmann
>
> The plugin does not respect generated content (from velocity templates), for example the project at:
> http://svn.codehaus.org/mojo/trunk/mojo/was6-maven-plugin/
> generates completely valid documentation - but the plugin fails with:
> [INFO] [docck:check {execution: verify}]
> [INFO] Checking project: WAS6 Maven Plugin
> [INFO] Using 2 extractors.
> [INFO] Applying extractor for language: java
> [INFO] Extractor for language: java found 12 mojo descriptors.
> [INFO] Applying extractor for language: bsh
> [INFO] Extractor for language: bsh found 0 mojo descriptors.
> [ERROR] The following documentation problems were found:
> o WAS6 Maven Plugin (3 errors, 0 warnings)
>   [ERROR] There is no 'usage' file in your site directory (in apt|html|xml format).
>   [ERROR] There are no example files in your site directory (in apt|html|xml format). They should either be called 'example*.(apt|html|xml)' or they should be located in the 'examples' directory.
>   [ERROR] There is no 'faq' file in your site directory (in apt|fml|html|xml format).

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

        

[jira] Closed: (MDOCCK-14) Plugin does not respect generated documentation

Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MDOCCK-14?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Benjamin Bentmann closed MDOCCK-14.
-----------------------------------

      Assignee: Benjamin Bentmann
    Resolution: Duplicate

> Plugin does not respect generated documentation
> -----------------------------------------------
>
>                 Key: MDOCCK-14
>                 URL: http://jira.codehaus.org/browse/MDOCCK-14
>             Project: Maven 2.x Documentation Checker Plugin
>          Issue Type: Bug
>    Affects Versions: 1.0-beta-2
>         Environment: N/A
>            Reporter: David J. M. Karlsen
>            Assignee: Benjamin Bentmann
>
> The plugin does not respect generated content (from velocity templates), for example the project at:
> http://svn.codehaus.org/mojo/trunk/mojo/was6-maven-plugin/
> generates completely valid documentation - but the plugin fails with:
> [INFO] [docck:check {execution: verify}]
> [INFO] Checking project: WAS6 Maven Plugin
> [INFO] Using 2 extractors.
> [INFO] Applying extractor for language: java
> [INFO] Extractor for language: java found 12 mojo descriptors.
> [INFO] Applying extractor for language: bsh
> [INFO] Extractor for language: bsh found 0 mojo descriptors.
> [ERROR] The following documentation problems were found:
> o WAS6 Maven Plugin (3 errors, 0 warnings)
>   [ERROR] There is no 'usage' file in your site directory (in apt|html|xml format).
>   [ERROR] There are no example files in your site directory (in apt|html|xml format). They should either be called 'example*.(apt|html|xml)' or they should be located in the 'examples' directory.
>   [ERROR] There is no 'faq' file in your site directory (in apt|fml|html|xml format).

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

        

[jira] Commented: (MDOCCK-14) Plugin does not respect generated documentation

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MDOCCK-14?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=147712#action_147712 ] 

Dennis Lundberg commented on MDOCCK-14:
---------------------------------------

I'll look into making a release.

> Plugin does not respect generated documentation
> -----------------------------------------------
>
>                 Key: MDOCCK-14
>                 URL: http://jira.codehaus.org/browse/MDOCCK-14
>             Project: Maven 2.x Documentation Checker Plugin
>          Issue Type: Bug
>    Affects Versions: 1.0-beta-2
>         Environment: N/A
>            Reporter: David J. M. Karlsen
>            Assignee: Benjamin Bentmann
>
> The plugin does not respect generated content (from velocity templates), for example the project at:
> http://svn.codehaus.org/mojo/trunk/mojo/was6-maven-plugin/
> generates completely valid documentation - but the plugin fails with:
> [INFO] [docck:check {execution: verify}]
> [INFO] Checking project: WAS6 Maven Plugin
> [INFO] Using 2 extractors.
> [INFO] Applying extractor for language: java
> [INFO] Extractor for language: java found 12 mojo descriptors.
> [INFO] Applying extractor for language: bsh
> [INFO] Extractor for language: bsh found 0 mojo descriptors.
> [ERROR] The following documentation problems were found:
> o WAS6 Maven Plugin (3 errors, 0 warnings)
>   [ERROR] There is no 'usage' file in your site directory (in apt|html|xml format).
>   [ERROR] There are no example files in your site directory (in apt|html|xml format). They should either be called 'example*.(apt|html|xml)' or they should be located in the 'examples' directory.
>   [ERROR] There is no 'faq' file in your site directory (in apt|fml|html|xml format).

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