maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Herve Boutemy (JIRA)" <j...@codehaus.org>
Subject [jira] Commented: (MJAVADOC-283) isValidJavadocLink should be more strict
Date Tue, 04 Jan 2011 12:13:58 GMT

    [ http://jira.codehaus.org/browse/MJAVADOC-283?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=250366#action_250366
] 

Herve Boutemy commented on MJAVADOC-283:
----------------------------------------

or read tha actual content downloaded and check that there a no spaces nor <: I think this
heuristic should be sufficient
WDYT?

> isValidJavadocLink should be more strict
> ----------------------------------------
>
>                 Key: MJAVADOC-283
>                 URL: http://jira.codehaus.org/browse/MJAVADOC-283
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: Improvement
>    Affects Versions: 2.6.1
>         Environment: Apache Maven 2.2.1 (r801777; 2009-08-06 21:16:01+0200)
> Java version: 1.5.0_16-p9
> Java home: /usr/local/jdk-1.5.0/jre
> Default locale: de_DE, platform encoding: ISO8859-15
> OS name: "openbsd" version: "4.6" arch: "i386" Family: "unix"
>            Reporter: Christian Schulte
>            Priority: Blocker
>         Attachments: MJAVADOC-283.patch
>
>
> When setting 'detectLinks' to 'true', the plugin checks that access to the constructed
package-list files is possible by checking the HTTP status code to match 200. This check should
be more strict and additionally check that the accessed package-list file is of correct type.
For example, if setting detect links to 'true' and having a dependency on 'javax.annotation:jsr250-api'
the plugin will add a link like 'http://jcp.org/aboutJava/communityprocess/final/jsr250/index.html/apidocs'
so that javadoc will then try to access the package-list file located at 'http://jcp.org/aboutJava/communityprocess/final/jsr250/index.html/apidocs/package-list'.
That link returns a HTTP status code 200 but no valid package-list file. Using the following
javadoc plugin configuration
> {code:xml}
>         <plugin>
>           <groupId>org.apache.maven.plugins</groupId>
>           <artifactId>maven-javadoc-plugin</artifactId>
>           <version>2.7</version>
>           <configuration>
>             <breakiterator>true</breakiterator>
>             <keywords>true</keywords>
>             <linksource>true</linksource>
>             <serialwarn>true</serialwarn>
>             <source>1.5</source>
>             <doctitle>${project.name} ${project.version}</doctitle>
>             <windowtitle>${project.name} ${project.version}</windowtitle>
>             <detectJavaApiLink>true</detectJavaApiLink>
>             <detectOfflineLinks>false</detectOfflineLinks>
>             <detectLinks>true</detectLinks>
>             <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
>             <docletArtifact>
>               <groupId>org.umlgraph</groupId>
>               <artifactId>doclet</artifactId>
>               <version>5.1</version>
>             </docletArtifact>
>             <tagletArtifacts>
>               <tagletArtifact>
>                 <groupId>org.apache.maven.plugin-tools</groupId>
>                 <artifactId>maven-plugin-tools-javadoc</artifactId>
>                 <version>2.5</version>
>               </tagletArtifact>
>               <tagletArtifact>
>                 <groupId>org.codehaus.plexus</groupId>
>                 <artifactId>plexus-javadoc</artifactId>
>                 <version>1.0</version>
>               </tagletArtifact>
>             </tagletArtifacts>
>             <additionalparam>
>               -inferrel -inferdep -hide java.* -collpackages java.util.* -qualify -postfixpackage
-nodefontsize 9
>               -nodefontpackagesize 7
>             </additionalparam>
>             <archive>
>               <index>true</index>
>               <addMavenDescriptor>false</addMavenDescriptor>
>               <compress>true</compress>
>             </archive>
>           </configuration>
>         </plugin>
> {code}
>  
> the configured umlgraph doclet will fail when trying to parse the retrieved HTML document
as a package-list file.

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

        

Mime
View raw message