Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.15 KB

glossary.adoc

File metadata and controls

53 lines (41 loc) · 1.15 KB
Raw

Glossary

Description

Generate a glossary document from code analysis :

  • the entry is the name of a class marked with a specific annotation

  • the definition is the javadoc of this class

    mojo

    glossary

Configuration

annotation

the short name of annotation used to find glossary entries (default is Glossary)

format

the format of output document : asciidoc, html (default is html)

sources

the source folder to scan (default is src/main/java)

outputDirectory

the outpout directory (default is target/generated-docs)

Usage

Code
/**
    A little pet with a pv and hp
 */
@Glossary
public class Pokemon {
...
}
Maven
    <plugin>
        <groupId>io.github.livingdocumentation</groupId>
        <artifactId>livingdoc-maven-plugin</artifactId>
        <version>${plugin.livingdoc-maven-plugin.version}</version>
        <executions>
            <execution>
                <id>glossary</id>
                <phase>generate-resources</phase>
                <goals>
                    <goal>glossary</goal>
                </goals>
            </execution>
        </executions>
    </plugin>