JavaDoq 1.0 API

com.javadoq
Class JavaDoq

java.lang.Object
  extended by com.javadoq.JavaDoq

public final class JavaDoq
extends java.lang.Object

Converts Java source code to HTML documents.

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

Field Summary
 java.lang.String dst
          Target directory name.
 java.util.Map<java.lang.String,JavaPackage> packages
          All packages of source code to convert.
 java.lang.String src
          Source directory name.
 java.lang.String title
          Title for target HTML documents.
static java.lang.String VERSION
          Version of JavaDoq.
 
Constructor Summary
JavaDoq()
           
 
Method Summary
 void build()
          Builds HTML documents by the definitions.
 JavaPackage findPackage(JavaName qname)
          Gets a JavaPackage.
 JavaType findType(JavaName qname)
          Gets a JavaType.
 java.util.List<SourceFile> getAllFiles()
          Gets all files of source code to convert.
static void main(java.lang.String[] args)
          Builds HTML documents from a console.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION

public static final java.lang.String VERSION

Version of JavaDoq.

Since:
1.0
See Also:
Constant Field Values

title

public java.lang.String title

Title for target HTML documents.

Since:
1.0

src

public java.lang.String src

Source directory name.

Since:
1.0

dst

public java.lang.String dst

Target directory name.

Since:
1.0

packages

public final java.util.Map<java.lang.String,JavaPackage> packages

All packages of source code to convert.

Since:
1.0
Constructor Detail

JavaDoq

public JavaDoq()
Method Detail

getAllFiles

public final java.util.List<SourceFile> getAllFiles()

Gets all files of source code to convert.

Returns:
All files of source code to convert.
Since:
1.0

findPackage

public final JavaPackage findPackage(JavaName qname)

Gets a JavaPackage.

Parameters:
qname - The fully qualified name of the package.
Returns:
A JavaPackage that has qname.
Since:
1.0

findType

public final JavaType findType(JavaName qname)

Gets a JavaType.

Parameters:
qname - The fully qualified name of the Java type.
Returns:
A JavaType that has qname.
Since:
1.0

build

public final void build()

Builds HTML documents by the definitions.

Since:
1.0

main

public static void main(java.lang.String[] args)

Builds HTML documents from a console.

Parameters:
args - Arguments
Since:
1.0

JavaDoq 1.0 API

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