TOC

Mavenベースのプロジェクト用にjavadoc jarを生成する

Mavenベースのプロジェクトのjavadoc jarを生成する

「http://maven.apache.org/plugins/maven-javadoc-plugin/[maven-javadoc]」プラグインは「JDKin\javadoc.exe」コマンドを使用してjavadocsを生成し、jarファイルにパックしてデプロイしますあなたのプロジェクトと一緒に。

1. Maven JavaDocプラグイン

「pom.xml」ファイルに「maven-javadoc」プラグインを追加します。

ファイル：pom.xml 


    4.0.0
    com.example
    examplecore
    jar
    1.0
    examplecore project
    http://maven.apache.org
    
    
        
            org.apache.maven.plugins
            maven-javadoc-plugin
            
                
                    attach-javadocs
                    
                        jar

2. 配備する

「mvn install」を発行すると、javadocが生成され、プロジェクトがパッケージ化されてローカルリポジトリにデプロイされます。 

D:\exampleweb-core>mvn install
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Building examplecore project
[INFO]    task-segment: [install]
[INFO] ------------------------------------------------------------------------
//...
Loading source files for package com.example.core...
Constructing Javadoc information...
Standard Doclet version 1.6.0_13
Building tree for all the packages and classes...
Generating D:/exampleweb-core/target/apidocs\com/example/core/\App.html...
Generating D:/exampleweb-core/target/apidocs\com/example/core/\package-frame.html...
Generating D:/exampleweb-core/target/apidocs\com/example/core/\package-summary.html...
Generating D:/exampleweb-core/target/apidocs\com/example/core/\package-tree.html...
Generating D:/exampleweb-core/target/apidocs\constant-values.html...
Generating D:/exampleweb-core/target/apidocs\com/example/core/\class-use\App.html...
Generating D:/exampleweb-core/target/apidocs\com/example/core/\package-use.html...
Building index for all the packages and classes...
Generating D:/exampleweb-core/target/apidocs\overview-tree.html...
Generating D:/exampleweb-core/target/apidocs\index-all.html...
Generating D:/exampleweb-core/target/apidocs\deprecated-list.html...
Building index for all classes...
Generating D:/exampleweb-core/target/apidocs\allclasses-frame.html...
Generating D:/exampleweb-core/target/apidocs\allclasses-noframe.html...
Generating D:/exampleweb-core/target/apidocs\index.html...
Generating D:/exampleweb-core/target/apidocs\help-doc.html...
Generating D:/exampleweb-core/target/apidocs\stylesheet.css...
[INFO] Building jar: D:\exampleweb-core\target\examplecore-1.0-javadoc.jar
[INFO] [install:install {execution: default-install}]
[INFO] Installing D:\exampleweb-core\target\examplecore-1.0.jar to D:\maven\repo\com\mky
ong\examplecore\1.0\examplecore-1.0.jar
[INFO] Installing D:\exampleweb-core\target\examplecore-1.0-javadoc.jar to D:\maven\repo
\com\example\examplecore\1.0\examplecore-1.0-javadoc.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL

3. 出力

ローカルリポジトリを参照すると、2つのjarファイルが作成されます。

  1. examplecore-1.0.jar (classes)

  2. examplecore-1.0-javadoc.jar (javadoc)

generate javadoc with Maven

Related