Maven 2.x Javadoc Plugin

Stylesheet file loaded from classpath

Details

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

Description

stylesheetfile can only be loaded from a file path. To allow common stylesheet definition it would be nice to load stylesheetfile from classpath.

Such a feature could be provided by extending the stylesheet type "maven" by allowing to provide your own stylesheet.css and not only the default maven one.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Vincent Siveton added a comment -

Are you sure? Could you provide us a test case?
http://maven.apache.org/plugins/maven-javadoc-plugin/examples/stylesheet-configuration.html
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#stylesheetfile
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#resourcesArtifacts

Show
Vincent Siveton added a comment - Are you sure? Could you provide us a test case? http://maven.apache.org/plugins/maven-javadoc-plugin/examples/stylesheet-configuration.html http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#stylesheetfile http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#resourcesArtifacts
Hide
Permalink
Julien Eluard added a comment -

Test case

Show
Julien Eluard added a comment - Test case
Hide
Permalink
Julien Eluard added a comment -

I was not aware of the resourcesArtifacts feature.
What is the behaviour? Will all files from artifacts' src/resources be copied under reportOutputDirectory?

Show
Julien Eluard added a comment - I was not aware of the resourcesArtifacts feature. What is the behaviour? Will all files from artifacts' src/resources be copied under reportOutputDirectory?
Hide
Permalink
Vincent Siveton added a comment -

According your test case, you need to call:

mvn javadoc:javadoc -Dstylesheetfile=${basedir}\src\resources\org\apache\maven\pugin\javadoc\css\stylesheet.css

See MJAVADOC-126 about resourcesArtifacts

Could you confirm that I could close this issue as not bug?

Show
Vincent Siveton added a comment - According your test case, you need to call: mvn javadoc:javadoc -Dstylesheetfile=${basedir}\src\resources\org\apache\maven\pugin\javadoc\css\stylesheet.css See MJAVADOC-126 about resourcesArtifacts Could you confirm that I could close this issue as not bug?
Hide
Permalink
Julien Eluard added a comment -

The thing is I don't want to rely on file path to load the stylesheet because ultimately my stylesheet will be stored in a parent dependency.
When using 'maven' as stylesheet property (http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#stylesheet) maven-javadoc-plugin loads from classpath org/apache/maven/plugin/javadoc/css/stylesheet.css but I can't provide my own stylesheet.css file.

Show
Julien Eluard added a comment - The thing is I don't want to rely on file path to load the stylesheet because ultimately my stylesheet will be stored in a parent dependency. When using 'maven' as stylesheet property ( http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#stylesheet ) maven-javadoc-plugin loads from classpath org/apache/maven/plugin/javadoc/css/stylesheet.css but I can't provide my own stylesheet.css file.
Hide
Permalink
Vincent Siveton added a comment -

fixed in r794885, snapshot deployed

Show
Vincent Siveton added a comment - fixed in r794885 , snapshot deployed

People

  • Assignee:
    Vincent Siveton
    Reporter:
    Julien Eluard
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: