[ 
https://issues.apache.org/jira/browse/MJAVADOC-453?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Ljuba updated MJAVADOC-453:
---------------------------
    Description: 
Please, update documentation example on page [Using Alternate 
Doclet|http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html]
 with following snippet  that works: 

{code:xml}
        <build>
                <plugins>
                                <plugin>
                                <groupId>org.apache.maven.plugins</groupId>
                                <artifactId>maven-javadoc-plugin</artifactId>
                                <version>2.10.3</version>
                                <configuration>
                                        
<doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>

                                        <!-- 
<docletPath>/path/to/UmlGraph.jar</docletPath> -->
                                        <docletArtifact>
                                                <groupId>org.umlgraph</groupId>
                                                
<artifactId>umlgraph</artifactId>
                                                <version>5.6.6</version>
                                        </docletArtifact>
                                        
<additionalparam>-views</additionalparam>
                                        
<useStandardDocletOptions>true</useStandardDocletOptions>
                                        
<additionalparam>-Xdoclint:none</additionalparam> <!-- for java 1.8 -->
                                </configuration>
                        </plugin>
                </plugins>
        </build>
{code}


This is current documentation example snippet:

{code:xml}
<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.3</version>
        <configuration>
          <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>

          <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
          <docletArtifact>
            <groupId>org.umlgraph</groupId>
            <artifactId>doclet</artifactId>
            <version>5.1</version>
          </docletArtifact>
          <additionalparam>-views</additionalparam>
          <useStandardDocletOptions>true</useStandardDocletOptions>
        </configuration>
      </plugin>
    ...
    </plugins>
  </reporting> (or </build>)
  ...
</project>
{code}
Current documentation example snippet yields this error:
{noformat}
UmlGraphDoc version 5.1, altering javadocs
Building Package view for package ...
Warning, could not find a line that matches the pattern '</H2>'.
 Class diagram reference not inserted
{noformat}


  was:
Please, update documentation example on page [Using Alternate 
Doclet|http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html]
 with following snippet  that works: 

{code:xml}
        <build>
                <plugins>
                                <plugin>
                                <groupId>org.apache.maven.plugins</groupId>
                                <artifactId>maven-javadoc-plugin</artifactId>
                                <version>2.10.3</version>
                                <configuration>
                                        
<doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>

                                        <!-- 
<docletPath>/path/to/UmlGraph.jar</docletPath> -->
                                        <docletArtifact>
                                                <groupId>org.umlgraph</groupId>
                                                
<artifactId>umlgraph</artifactId>
                                                <version>5.6.6</version>
                                        </docletArtifact>
                                        
<additionalparam>-views</additionalparam>
                                        
<useStandardDocletOptions>true</useStandardDocletOptions>
                                        
<additionalparam>-Xdoclint:none</additionalparam>
                                </configuration>
                        </plugin>
                </plugins>
        </build>
{code}


This is current documentation example snippet:

{code:xml}
<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.3</version>
        <configuration>
          <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>

          <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
          <docletArtifact>
            <groupId>org.umlgraph</groupId>
            <artifactId>doclet</artifactId>
            <version>5.1</version>
          </docletArtifact>
          <additionalparam>-views</additionalparam>
          <useStandardDocletOptions>true</useStandardDocletOptions>
        </configuration>
      </plugin>
    ...
    </plugins>
  </reporting> (or </build>)
  ...
</project>
{code}
Current documentation example snippet yield this error:
{noformat}
UmlGraphDoc version 5.1, altering javadocs
Building Package view for package ...
Warning, could not find a line that matches the pattern '</H2>'.
 Class diagram reference not inserted
{noformat}



> Using Alternate Doclet documentation example snippet is out of date and does 
> not work
> -------------------------------------------------------------------------------------
>
>                 Key: MJAVADOC-453
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-453
>             Project: Maven Javadoc Plugin
>          Issue Type: Documentation
>          Components: javadoc
>            Reporter: Ljuba
>              Labels: documentation
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Please, update documentation example on page [Using Alternate 
> Doclet|http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html]
>  with following snippet  that works: 
> {code:xml}
>       <build>
>               <plugins>
>                               <plugin>
>                               <groupId>org.apache.maven.plugins</groupId>
>                               <artifactId>maven-javadoc-plugin</artifactId>
>                               <version>2.10.3</version>
>                               <configuration>
>                                       
> <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
>                                       <!-- 
> <docletPath>/path/to/UmlGraph.jar</docletPath> -->
>                                       <docletArtifact>
>                                               <groupId>org.umlgraph</groupId>
>                                               
> <artifactId>umlgraph</artifactId>
>                                               <version>5.6.6</version>
>                                       </docletArtifact>
>                                       
> <additionalparam>-views</additionalparam>
>                                       
> <useStandardDocletOptions>true</useStandardDocletOptions>
>                                       
> <additionalparam>-Xdoclint:none</additionalparam> <!-- for java 1.8 -->
>                               </configuration>
>                       </plugin>
>               </plugins>
>       </build>
> {code}
> This is current documentation example snippet:
> {code:xml}
> <project>
>   ...
>   <reporting> (or <build>)
>     <plugins>
>       <plugin>
>         <groupId>org.apache.maven.plugins</groupId>
>         <artifactId>maven-javadoc-plugin</artifactId>
>         <version>2.10.3</version>
>         <configuration>
>           <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
>           <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
>           <docletArtifact>
>             <groupId>org.umlgraph</groupId>
>             <artifactId>doclet</artifactId>
>             <version>5.1</version>
>           </docletArtifact>
>           <additionalparam>-views</additionalparam>
>           <useStandardDocletOptions>true</useStandardDocletOptions>
>         </configuration>
>       </plugin>
>     ...
>     </plugins>
>   </reporting> (or </build>)
>   ...
> </project>
> {code}
> Current documentation example snippet yields this error:
> {noformat}
> UmlGraphDoc version 5.1, altering javadocs
> Building Package view for package ...
> Warning, could not find a line that matches the pattern '</H2>'.
>  Class diagram reference not inserted
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to