byucc.jhdl.util.xmac
Class JavadocParser

java.lang.Object
  byucc.jhdl.util.xmac.TagParser
      byucc.jhdl.util.xmac.JavadocParser

public class JavadocParser

extends TagParser

Parse the javadoc tag. This class takes the user comments in the javadoc tag and formats them neatly for the output java file.

Example:
<javadoc>
This is a javadoc comment
</javadoc>

Results in:
/**
* This is a javadoc comment
*/

Author:

Isaac E. Wagner

Field Summary

Fields inherited from class byucc.jhdl.util.xmac.TagParser

docInfo

Constructor Summary

JavadocParser(DocInfo docInfo)
Construct a new JavadocParser.

Method Summary

void	parse(org.w3c.dom.Node docRoot) Parse the javadoc tag.

Methods inherited from class byucc.jhdl.util.xmac.TagParser

checkParent, countLines, decreaseIndent, increaseIndent, indentBlock, indentLine, indentLine, outmsg, parse, strBlockToArray, writeOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocParser

public JavadocParser(DocInfo docInfo)
              throws java.lang.Exception

Construct a new JavadocParser.

Parameters:

docInfo - The DocInfo object that contains all the info about this class.

Method Detail

parse

public void parse(org.w3c.dom.Node docRoot)
           throws java.lang.Exception

Parse the javadoc tag. This method invokes the parser on the javadoc tag.

Overrides:

parse in class TagParser

Parameters:

docRoot - The Node of the javadoc tag to process.

Returns:

None

Throws:

java.lang.Exception