JavaDoq 1.0 API

com.javadoq.html
Class DoqHTMLJavaFile

java.lang.Object
  extended by com.javadoq.html.Doq
      extended by com.javadoq.html.DoqHTMLFile
          extended by com.javadoq.html.DoqHTMLBody
              extended by com.javadoq.html.DoqHTMLSourceFile
                  extended by com.javadoq.html.DoqHTMLJavaFile

public final class DoqHTMLJavaFile
extends DoqHTMLSourceFile

Transforms Java, JavaCC or JJTree source files to HTML files.

Author:
J.J.Liu (Jianjun Liu) at http://www.javadoq.com

Nested Class Summary
 
Nested classes/interfaces inherited from class com.javadoq.html.DoqHTMLSourceFile
DoqHTMLSourceFile.CharStream
 
Field Summary
 
Fields inherited from class com.javadoq.html.DoqHTMLSourceFile
file, format
 
Fields inherited from class com.javadoq.html.DoqHTMLFile
jdoq
 
Fields inherited from class com.javadoq.html.Doq
fileName, fileWriter, LINE_SEPARATOR, STYLE_SHEET
 
Constructor Summary
DoqHTMLJavaFile(SourceFile file)
          Constructs a DoqHTMLJavaFile transformer.
 
Method Summary
 void parse()
          Parses the source file and converts it to an HTML file.
 
Methods inherited from class com.javadoq.html.DoqHTMLSourceFile
close, getLineNumber, writeHTML, writeHTML, writeHTML
 
Methods inherited from class com.javadoq.html.DoqHTMLFile
writeFrameItem
 
Methods inherited from class com.javadoq.html.Doq
write, write, writeLine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DoqHTMLJavaFile

public DoqHTMLJavaFile(SourceFile file)

Constructs a DoqHTMLJavaFile transformer.

This constructor invokes its super constructor to create or open the target file, open HTML and HTML body, and write the header.

Parameters:
file - The source file to transform.
Since:
1.0
Method Detail

parse

public final void parse()
                 throws java.io.IOException,
                        ParseException

Parses the source file and converts it to an HTML file.

Throws:
java.io.IOException - A java.io.IOException.
ParseException - A ParseException.
Since:
1.0

JavaDoq 1.0 API

Copyright © 2008-2011 J.J.Liu (www.javadoq.com). All Rights Reserved.