com.google.caja.ancillary.jsdoc
Class JsdocMain
java.lang.Object
com.google.caja.ancillary.jsdoc.JsdocMain
public class JsdocMain
- extends java.lang.Object
Has a main method that given a set of files produces JSON documentation.
- Author:
- mikesamuel@gmail.com
Method Summary |
private void |
addInitPaths(java.util.List<java.lang.String> paths)
Build the list of files that run before we take the first snapshot. |
private void |
classifyFiles(java.util.List<java.lang.String> paths)
Build the list of source files and packages from inputs. |
private java.util.List<Pair<InputSource,Comment>> |
getPackageDocs()
Store package documentation from package.html in the JSON output. |
static void |
main(java.lang.String[] argv)
|
private void |
parseInputs()
Parse input source files. |
private static java.util.List<java.lang.String> |
pathList(java.util.List<java.io.File> files)
|
private CharProducer |
readSource(java.lang.String path)
|
private void |
render(ParseTreeNode node,
java.lang.Appendable out)
|
private void |
reportMessages()
|
(package private) boolean |
run(java.util.List<java.lang.String> initPaths,
java.util.List<java.lang.String> srcPaths,
java.io.File docDir,
java.lang.Appendable out)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
mc
private final MessageContext mc
mq
private final MessageQueue mq
fs
private final FileSystem fs
handlers
private final AnnotationHandlers handlers
errStream
private final java.lang.Appendable errStream
packages
private final java.util.Set<java.lang.String> packages
sourcePaths
private final java.util.List<java.lang.String> sourcePaths
sourceContent
private final java.util.List<CharProducer> sourceContent
sources
private final java.util.List<ParseTreeNode> sources
initFiles
private final java.util.List<Pair<java.lang.String,java.lang.String>> initFiles
JsdocMain
JsdocMain(FileSystem fs,
java.lang.Appendable errStream)
main
public static void main(java.lang.String[] argv)
pathList
private static java.util.List<java.lang.String> pathList(java.util.List<java.io.File> files)
throws java.io.IOException
- Throws:
java.io.IOException
run
boolean run(java.util.List<java.lang.String> initPaths,
java.util.List<java.lang.String> srcPaths,
java.io.File docDir,
java.lang.Appendable out)
addInitPaths
private void addInitPaths(java.util.List<java.lang.String> paths)
- Build the list of files that run before we take the first snapshot.
These JavaScript files set up the Rhino environment so that the code
to doc will run properly.
classifyFiles
private void classifyFiles(java.util.List<java.lang.String> paths)
- Build the list of source files and packages from inputs.
readSource
private CharProducer readSource(java.lang.String path)
throws java.io.IOException
- Throws:
java.io.IOException
parseInputs
private void parseInputs()
- Parse input source files.
getPackageDocs
private java.util.List<Pair<InputSource,Comment>> getPackageDocs()
- Store package documentation from package.html in the JSON output.
reportMessages
private void reportMessages()
render
private void render(ParseTreeNode node,
java.lang.Appendable out)
Copyright (C) 2008 Google Inc.
Licensed under the Apache License, Version 2.0