github-doclet
インデックスに戻る
概要
各クラスのページにGitHub上のソースへのリンクを差し込むDocletです。
使い方
Mavenで使用する場合は以下のRepository定義とPlugin定義を追加して「mvn javadoc:javadoc」を実行します。
<repositories> <repository> <id>flect</id> <name>flect</name> <url>http://flect.github.io/maven-repo/</url> </repository> </repositories> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.9.1</version> <configuration> <doclet>jp.co.flect.doclets.github.Standard</doclet> <docletArtifact> <groupId>jp.co.flect</groupId> <artifactId>githubDoclet</artifactId> <version>1.0</version> </docletArtifact> <additionalparam>-github https://github.com/[YOUR USERNAME]/[YOUR REPOSITORY]/tree/master/src/main/java</additionalparam> <useStandardDocletOptions>true</useStandardDocletOptions> </configuration> </plugin> </plugins> </build>
最新版
ダウンロード - 1.0
ライセンス
MIT