Skip to content
master
Go to file
Code
This branch is even with shunjikonishi:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

README.md

Github Doclet

A custom doclet each class pages have link to github.

Usage

javadoc command

Use javadoc command with following parameters.

Maven

Add following repository and plugin.

<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>

About

No description, website, or topics provided.

Resources

You can’t perform that action at this time.