AutoDocs

Class

The main class and best entry-point to generate documentation. Currently, this supports generating from loaded classes to an output directory.

This is for webpage documentation. If another format is required, the schema must be run directly.

Extends

Object

Modifiers

public final

Constructors

new AutoDocs ()

Constructor

No description is available for this element.

Return Type

AutoDocs

Modifiers

public

Methods

generateDocumentation (String, String, String, File, File, String...)

Method

Generates documentation from the given packages. This will search all sub-packages. This method cannot be used in the IntelliJ run suite or similar, since the class code-source is unavailable.

The title and page description are used in the HTML meta tags. The body is used in the first element of the index page, above the class list.

Index	Type	Name
1	String	title
2	String	description
3	String	body
4	File	output
5	File	sourceFolder
6	String[]	namespaces

Return Type

void

Modifiers

public static varargs

// The body is displayed on the index page and rendered with markdown.
// You could stream a .md file to this.
AutoDocs.generateDocumentation(title, pageDescription, markdownBody, outputFolder, "org.example");

// Multiple packages can be used for filtering. Specify an empty "" string to catch everything.
AutoDocs.generateDocumentation(title, pageDescription, markdownBody, outputFolder, "org.example", "org.thing");

generateDocumentation (String, String, String, File, File, Class...)

Method

Generates documentation from loaded classes. This method cannot be used in the IntelliJ run suite or similar, since the class code-source is unavailable.

The title and page description are used in the HTML meta tags. The body is used in the first element of the index page, above the class list.

Index	Type	Name
1	String	title
2	String	description
3	String	body
4	File	output
5	File	source
6	Class[]	classes

Return Type

void

Modifiers

public static varargs

// The body is displayed on the index page and rendered with markdown.
// You could stream a .md file to this.
AutoDocs.generateDocumentation(title, pageDescription, markdownBody, outputFolder, MyClass.class);

// Multiple packages can be used for filtering. Specify an empty "" string to catch everything.
AutoDocs.generateDocumentation(title, pageDescription, markdownBody, outputFolder, sourceFolder, MyClass.class, YourClass.class);

generateDocumentation (String, String, String, File, File, File, String...)

Method

Generates documentation from loaded classes with their provided source Jar. This method was designed for building documentation in IntelliJ run suite, since the code-source of the loaded classes would be unavailable. The source file is used to identify all classes under the namespace.

The title and page description are used in the HTML meta tags. The body is used in the first element of the index page, above the class list.

Index	Type	Name
1	String	title
2	String	description
3	String	body
4	File	output
5	File	exec
6	File	source
7	String[]	namespaces

Return Type

void

Modifiers

public static varargs

// The body is displayed on the index page and rendered with markdown.
// You could stream a .md file to this.
AutoDocs.generateDocumentation(title, pageDescription, markdownBody, outputFolder, sourceJar, "org.example");

// Multiple packages can be used for filtering. Specify an empty "" string to catch everything.
AutoDocs.generateDocumentation(title, pageDescription, markdownBody, outputFolder, sourceJar, source, "org.example", "my.package");