ptolemy.moml.filter
Class ActorIndex
java.lang.Object
ptolemy.moml.filter.ActorIndex
public class ActorIndex
- extends java.lang.Object
Generate actor/demo index files.
For each actor that is listed in a file, generate a html file that
lists the models in which the actor appears.
For details, see $PTII/vergil/actor/docViewerHelp.htm
- Since:
- Ptolemy II 5.2
- Version:
- $Id: ActorIndex.java 47877 2008-01-24 00:35:12Z cxh $
- Author:
- Christopher Brooks
- Accepted Rating:
- Proposed Rating:
Method Summary |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ActorIndex
public ActorIndex()
generateActorIndex
public static void generateActorIndex(java.lang.String classesFileName,
java.lang.String modelsFileName,
java.lang.String outputDirectory)
throws java.lang.Exception
- Generate the index files.
- Parameters:
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.
- Throws:
java.lang.Exception
- If there is a problem reading or writing
a file.
main
public static void main(java.lang.String[] args)
throws java.lang.Exception
- Generate index documentation. The three arguments are passed to
generateActorIndex(String, String, String)
.
java -classpath "$PTII;$PTII/lib/diva.jar" ptolemy.moml.filter.ActorIndex allActors.txt models.txt doc/codeDoc
- Parameters:
args
- An array of three Strings
The name of the file that lists all the actors in which we are
interested.
The name of the file that lists all the models to be indexed.
The directory in which to write the index files.
- Throws:
java.lang.Exception
- If there is a problem reading or writing
a file.