Hello World from OSS Silicon Valley


HowToUse/Maven/3.2/javadoc


#contents

*Prerequisite [#sab99118]
-Maven (You can refer [[HowToUse/Maven/3.2]])

*Install&Setup [#xc81b7ad]
-

*HowToUse [#c2cfaa39]
:Step.1|
Prepare Maven project.

:Step.2|
Add the following description in POM.xml

 <build>
 ...
 <plugins>
 ... 
 
 <plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-javadoc-plugin</artifactId>
   <configuration>
     <author>true</author>
     <source>1.7</source>
     <show>protected</show>
     <encoding>UTF-8</encoding>
     <charset>UTF-8</charset>
     <docencoding>UTF-8</docencoding>
   </configuration>
 </plugin>
 
 ...
 </plugins>
 ...
 </build>

:Step.3|
Execute the following command.

 # mvn javadoc:javadoc

Then you can see javadoc in <maven project>/target/site/apidocs.

*Author [#vf11be22]
S.Yatsuzuka