public class ActorIndex
extends java.lang.Object
For details, see $PTII/vergil/actor/docViewerHelp.htm
Red (cxh) |
Red (cxh) |
Constructor and Description |
---|
ActorIndex() |
Modifier and Type | Method and Description |
---|---|
static void |
generateActorIndex(java.lang.String classesFileName,
java.lang.String modelsFileName,
java.lang.String outputDirectory)
Generate the index files.
|
static void |
main(java.lang.String[] args)
Generate index documentation.
|
public static void generateActorIndex(java.lang.String classesFileName, java.lang.String modelsFileName, java.lang.String outputDirectory) throws java.lang.Exception
classesFileName
- The name of the file that contains the
dot separated class names - one class per line.
This file is usually called allActors.txt, which is generated by
running the $PTII/doc/doclets/PtDoc doclet. For example, see
$PTII/doc/codeDoc/allActors.txtmodelsFileName
- The name of the file that contains the
urls that point to the models to be parsed, one model
per line. This file is usually called models.txt and is generated by
running ptolemy.actor.gui.HTMLAbout.outputDirectory
- Directory in which to write index files.
The files generated have the name actorNameidx.htm, where
actorName is the name of the actor. Typically, the value
for this parameter is doc/codeDoc.java.lang.Exception
- If there is a problem reading or writing
a file.public static void main(java.lang.String[] args) throws java.lang.Exception
generateActorIndex(String, String, String)
.
java -classpath "$PTII;$PTII/lib/diva.jar" ptolemy.moml.filter.ActorIndex allActors.txt models.txt doc/codeDoc
args
- An array of three Strings
java.lang.Exception
- If there is a problem reading or writing
a file.