pt.lsts.neptus.doc

Class DocumentationIndexGenerator

java.lang.Object

pt.lsts.neptus.doc.DocumentationIndexGenerator

public class DocumentationIndexGenerator
extends java.lang.Object

This class provides a program that generates the manual index to be used in the Neptus Help window

Author:

zp

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<DocumentationProvider>	documentationProviders
protected java.lang.String[]	sourceFolders

Constructor Summary

Constructors

Constructor and Description
DocumentationIndexGenerator()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sourceFolders

protected java.lang.String[] sourceFolders

documentationProviders

protected java.util.Vector<DocumentationProvider> documentationProviders

Constructor Detail

DocumentationIndexGenerator

public DocumentationIndexGenerator()

Method Detail

findClasses

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

Parameters:

curPackage - Current package

dir - The folder where to look for classes

result - Where to put the found DocumentationProvider classes

generateIndex

public static void generateIndex()
                          throws java.lang.Exception

Generates the manual index under doc/manual/index.html

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)

This program will generate the manual index by scanning all existing Java classes for documentation

Parameters:

args - unused