/**
A little pet with a pv and hp
*/
@Glossary
public class Pokemon {
...
}
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
glossary
the short name of annotation used to find glossary entries (default is Glossary)
the format of output document : asciidoc, html (default is html)
the source folder to scan (default is src/main/java)
the outpout directory (default is target/generated-docs)
/**
A little pet with a pv and hp
*/
@Glossary
public class Pokemon {
...
} <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>