gov.llnl.babel.backend.html

Class 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(Object[] fileNames)
docify creates all the html files for the xml reprresentation of the SIDL files.

Constructor Details

BabelDoc

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

Method Details

docify

public void docify(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. <!ELEMENT Library (Package*|Symbol+)> <!ATTLIST Library date CDATA #REQUIRED> <!ELEMENT Package (Comment, PackageSymbols, Classes, Interfaces,Enumerations)> <!ATTLIST Package name CDATA #REQUIRED version CDATA #REQUIRED> <!ELEMENT PackageSymbols (PackageSymbol)*> <!ELEMENT Classes (Symbol)*> <!ELEMENT Interface (Symbol)*> <!ELEMENT Enumerations (Symbol)*> 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