Maven 2.x Documentation Checker Plugin

Plugin does not respect generated documentation

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Duplicate
  • Affects Version/s: 1.0-beta-2
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Environment:
    N/A
  • Number of attachments :
    0

Description

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

Issue Links

Activity

Hide
David J. M. Karlsen added a comment -

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.

Show
David J. M. Karlsen added a comment - 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.
Hide
Dennis Lundberg added a comment -

I'll look into making a release.

Show
Dennis Lundberg added a comment - I'll look into making a release.

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: