Class DocOnly

java.lang.Object
eu.bandm.tools.tdom.runtime.BaseVisitor
eu.bandm.tools.d2d2.absy.Visitor
eu.bandm.tools.d2d2.base.DocOnly
All Implemented Interfaces:
PCDataVisitor

public class DocOnly extends eu.bandm.tools.d2d2.absy.Visitor
A source file which only adds comments to existing modules. Uses a subset of the ddf parsing rules, and is fed into the documentation generation process of Def2Doc3.
Usage: create one fresh instance (no re-usage), invoke fromFile(File), invoke distribute(ModuleRegistry,String,boolean). This will modify the data of the (uninstalled) module contained in the ModuleRegistry.

(The code for parsing is just a modified subset of Reducer.)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) String
    This is a VERBATIM COPY from Reducer.
    (package private) CheckedList<LocString>
     
    protected String
     
    protected File
     
    static final String
     
     
    protected String
     
     

    Fields inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

    validating
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    distribute(ModuleRegistry moduleReg, String key, boolean replace)
     
    protected void
     
    protected void
     
    protected void
     
    void
    fromFile(File inputFile)
     
    protected void
     
    protected void
     
    void
    visit(eu.bandm.tools.d2d2.absy.Element_doctext element)
     
    void
    visit(eu.bandm.tools.d2d2.absy.Element_documentation element)
    <!ELEMENT documentation (ident, reflist?, (doctext | longdoctext)) >
    void
    visit(eu.bandm.tools.d2d2.absy.Element_longdoctext element)
     
    void
    visit(eu.bandm.tools.d2d2.absy.Element_module element)
     
    protected void
     

    Methods inherited from class eu.bandm.tools.d2d2.absy.Visitor

    visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

    Methods inherited from class eu.bandm.tools.tdom.runtime.BaseVisitor

    visit

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait