public class DocumentationIndexGenerator
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.util.Vector<DocumentationProvider> |
documentationProviders |
protected java.lang.String[] |
sourceFolders |
Constructor and Description |
---|
DocumentationIndexGenerator() |
Modifier and Type | Method and Description |
---|---|
protected static void |
findClasses(java.lang.String curPackage,
java.io.File dir,
java.util.Vector<DocumentationProvider> result)
This recursive method looks for Java classes that provide documentation
|
static void |
generateIndex()
Generates the manual index under doc/manual/index.html
|
static void |
main(java.lang.String[] args)
This program will generate the manual index by scanning all existing Java classes for documentation
|
protected java.lang.String[] sourceFolders
protected java.util.Vector<DocumentationProvider> documentationProviders
protected static void findClasses(java.lang.String curPackage, java.io.File dir, java.util.Vector<DocumentationProvider> result)
curPackage
- Current packagedir
- The folder where to look for classesresult
- Where to put the found DocumentationProvider
classespublic static void generateIndex() throws java.lang.Exception
java.lang.Exception
public static void main(java.lang.String[] args)
args
- unusedCopyright © 2004-2020 FEUP-LSTS and Neptus developers. All Rights Reserved.