gov.llnl.babel.backend.html
Class BabelDoc

java.lang.Object
  extended by gov.llnl.babel.backend.html.BabelDoc

public class BabelDoc
extends java.lang.Object

BabelDoc is used to create an html documentation of an XML definition of a SIDL file and/or package similar to javadoc. The assumption is made that the XML file accurately represent the sidl.dtd as we do non-validating parsing.


Constructor Summary
BabelDoc(Context context)
          We do not allow the public creation of a BabelDoc object.
 
Method Summary
 void docify(java.lang.Object[] fileNames)
          docify creates all the html files for the xml reprresentation of the SIDL files.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BabelDoc

public BabelDoc(Context context)
We do not allow the public creation of a BabelDoc object.

Method Detail

docify

public void docify(java.lang.Object[] fileNames)
            throws BabelDocException
docify creates all the html files for the xml reprresentation of the SIDL files. It does a slight transformation to make some of the trnslations easier. The dtd for the transformed document is as follows. Where Symbol, PackageSymbol and Comment are defined in sidl.dtd This allows us to not have to open and read the seperate xml files numerous times during the document creation.

Parameters:
fileNames - Files which will be processed into html documentation
Throws:
javax.xml.transform.TransformerException
javax.xml.transform.TransformerConfigurationException
java.io.FileNotFoundException
BabelDocException