github-doclet

Return to index link to github

Overview

A custom doclet each class pages have link to GitHub.


Usage

If you use maven, add following repository and plugin definitions, and run '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>

Latest release

Download - 1.0


License

MIT