Maven 2.x Javadoc Plugin

Javadoc plugin: java files under src/main/javadoc and doc-files directory are being compiled

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 2.6
  • Fix Version/s: 2.6.1
  • Labels:
    None
  • Number of attachments :
    1

Description

Maven was trying to compile src/main/javadoc/my/company/doc-files/Foo.java even though I set the docfilessubdirs configuration option to true. Renaming it to .txt works, however maven should probably not compile anything under src/main/javadoc/

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Benjamin Bentmann added a comment -

Can you provide some more details, like a build log that shows what plugin is actually compiling the code or preferably a little example project to demonstrate the issue?

Show
Benjamin Bentmann added a comment - Can you provide some more details, like a build log that shows what plugin is actually compiling the code or preferably a little example project to demonstrate the issue?
Hide
Permalink
Chris Wilkes added a comment -

"mvn javadoc:javadoc" will return [INFO] ------------------------------------------------------------------------
[INFO] An error has occurred in JavaDocs report generation:Exit code: 1 - javadoc: error - Illegal package name: "example.doc-files"

Show
Chris Wilkes added a comment - "mvn javadoc:javadoc" will return [INFO] ------------------------------------------------------------------------ [INFO] An error has occurred in JavaDocs report generation:Exit code: 1 - javadoc: error - Illegal package name: "example.doc-files"
Hide
Permalink
Vincent Siveton added a comment -

Confirmed.

I guess we could add a filter for java files, but the doc for docfilessubdirs [1] doesnt speak about java files.
So we need to understand your use case to add java files in javadoc dir.
You could also provide a patch (always better).

[1] http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs

Show
Vincent Siveton added a comment - Confirmed. I guess we could add a filter for java files, but the doc for docfilessubdirs [1] doesnt speak about java files. So we need to understand your use case to add java files in javadoc dir. You could also provide a patch (always better). [1] http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs
Hide
Permalink
Vincent Siveton added a comment -

fixed in r805778, snap deployed

Show
Vincent Siveton added a comment - fixed in r805778 , snap deployed

People

  • Assignee:
    Vincent Siveton
    Reporter:
    Chris Wilkes
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: