AurigaDoclet
API
Author:
Khurshidali
Shaikh
Organization:
Auriga
Logic
©
Copyright
Auirga
Logic
Pvt.
Ltd.
All
Rights
Reserved
Generated
with
AurigaDoclet
<
http://aurigadoclet.sourceforge.net>
Table
Of
Content
com.aurigalogic.doclet.core
........................................................................................
3
Doclet
...............................................................................................................
3
XMLGenerator
...................................................................................................
7
com.aurigalogic.doclet.util
..........................................................................................
9
Util
....................................................................................................................
9
com.aurigalogic.doclet.writer
....................................................................................
11
AbstractDocWriter
...........................................................................................
12
CssTreeBuilder
................................................................................................
15
DocWriter
........................................................................................................
17
FODocWriter
....................................................................................................
19
MIFDocWriter
...................................................................................................
21
PCLDocWriter
..................................................................................................
22
PDFDocWriter
..................................................................................................
23
PSDocWriter
....................................................................................................
25
SVGDocWriter
..................................................................................................
26
Index
........................................................................................................................
28
Package
com.aurigalogic.doclet.core
Class
Summary
Doclet
Doclet
class
for
AurigaDoclet
XMLGenerator
Class
which
generates
an
xml
tree
from
the
RootDoc.
com.aurigalogic.doclet.core
Class
Doclet
java.lang.Object
|
+--com.sun.javadoc.Doclet
|
+--com.aurigalogic.doclet.core.Doclet
<
Fields
>
<
Constructors
>
<
Methods
>
public
class
Doclet
extends
com.sun.javadoc.Doclet
Doclet
class
for
AurigaDoclet
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1
$
$Date:
2003/12/24
12:41:39
$
Fields
BOTTOM_MARGIN
protected
static
final
java.lang.String
BOTTOM_MARGIN
AurigaDoclet
API
Document
Pg
-
3
COVER_FILE
protected
static
final
java.lang.String
COVER_FILE
COVER_TEXT
protected
static
final
java.lang.String
COVER_TEXT
CSS_FILE
protected
static
final
java.lang.String
CSS_FILE
FOOTER_FILE
protected
static
final
java.lang.String
FOOTER_FILE
FOOTER_HEIGHT
protected
static
final
java.lang.String
FOOTER_HEIGHT
FOOTER_TEXT
protected
static
final
java.lang.String
FOOTER_TEXT
FORMAT
protected
static
final
java.lang.String
FORMAT
HEADER_FILE
protected
static
final
java.lang.String
HEADER_FILE
AurigaDoclet
API
Document
Pg
-
4
HEADER_HEIGHT
protected
static
final
java.lang.String
HEADER_HEIGHT
HEADER_TEXT
protected
static
final
java.lang.String
HEADER_TEXT
LEFT_MARGIN
protected
static
final
java.lang.String
LEFT_MARGIN
NO_INDEX
protected
static
final
java.lang.String
NO_INDEX
NO_LINKS
protected
static
final
java.lang.String
NO_LINKS
NO_NAVIGATION
protected
static
final
java.lang.String
NO_NAVIGATION
NO_TOC
protected
static
final
java.lang.String
NO_TOC
OUTPUT
protected
static
final
java.lang.String
OUTPUT
AurigaDoclet
API
Document
Pg
-
5
RIGHT_MARGIN
protected
static
final
java.lang.String
RIGHT_MARGIN
TOP_MARGIN
protected
static
final
java.lang.String
TOP_MARGIN
XSL_FILE
protected
static
final
java.lang.String
XSL_FILE
Constructors
Doclet
public
Doclet
(java.lang.String[][]
options)
Default
constructor.
Methods
optionLength
public
static
int
optionLength
(java.lang.String
option)
Returns
the
option
length
for
supported
command
line
options.
start
public
static
boolean
start
(RootDoc
rootDoc)
Entry
point
for
this
doclet.
AurigaDoclet
API
Document
Pg
-
6
validOptions
public
static
boolean
validOptions
(java.lang.String[][]
options,
DocErrorReporter
reporter)
Validates
the
options.
com.aurigalogic.doclet.core
Class
XMLGenerator
java.lang.Object
|
+--com.aurigalogic.doclet.core.XMLGenerator
<
Constructors
>
<
Methods
>
public
class
XMLGenerator
extends
java.lang.Object
Class
which
generates
an
xml
tree
from
the
RootDoc.
This
xml
is
then
transformed
to
various
formats.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1
$
$Date:
2003/12/24
12:41:39
$
Constructors
XMLGenerator
public
XMLGenerator
(java.lang.String[][]
options)
Default
constructor.
Methods
AurigaDoclet
API
Document
Pg
-
7
generateXML
public
void
generateXML
(RootDoc
rootDoc)
Generates
the
xml
tree.
Parameters:
rootDoc
-
the
javadoc
root.
getXMLStream
public
java.io.InputStream
getXMLStream
()
getXMLString
public
java.lang.String
getXMLString
()
AurigaDoclet
API
Document
Pg
-
8
Package
com.aurigalogic.doclet.util
Class
Summary
Util
Utility
class
com.aurigalogic.doclet.util
Class
Util
java.lang.Object
|
+--com.aurigalogic.doclet.util.Util
<
Methods
>
public
class
Util
extends
java.lang.Object
Utility
class
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Methods
readFile
public
static
java.lang.String
readFile
(java.lang.String
path)
Reads
a
file
and
returns
the
content
as
string.
AurigaDoclet
API
Document
Pg
-
9
tidy
public
static
java.lang.String
tidy
(java.lang.String
html)
Cleans
the
given
html
using
Tidy.
writeFile
public
static
void
writeFile
(java.lang.String
path,
java.lang.String
content)
Writes
the
given
given
text
to
the
specified
file.
AurigaDoclet
API
Document
Pg
-
10
Package
com.aurigalogic.doclet.writer
Interface
Summary
DocWriter
DocWriter
interface.
Class
Summary
AbstractDocWriter
Abstract
doc
writer.
CssTreeBuilder
This
class
parses
the
given
css
stream
and
builds
a
xml
tree.
FODocWriter
This
class
is
used
for
generating
javadoc
in
FO
format.
MIFDocWriter
MIF
document
writer.
PCLDocWriter
PCL
document
writer.
PDFDocWriter
PDF
document
generator.
PSDocWriter
Postscript
document
write.
SVGDocWriter
SVG
document
writer.
AurigaDoclet
API
Document
Pg
-
11
com.aurigalogic.doclet.writer
Class
AbstractDocWriter
java.lang.Object
|
+--com.aurigalogic.doclet.writer.AbstractDocWriter
All
Implemented
Interfaces:
DocWriter
Direct
Known
Subclasses:
FODocWriter
<
Fields
>
<
Constructors
>
<
Methods
>
public
abstract
class
AbstractDocWriter
extends
java.lang.Object
implements
DocWriter
Abstract
doc
writer.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Fields
OUTPUT_HTML
protected
static
final
java.lang.String
OUTPUT_HTML
OUTPUT_XML
protected
static
final
java.lang.String
OUTPUT_XML
cssStream
protected
java.io.InputStream
cssStream
AurigaDoclet
API
Document
Pg
-
12
log
protected
org.apache.avalon.framework.logger.ConsoleLogger
log
outputFile
protected
java.lang.String
outputFile
parameters
protected
java.util.Properties
parameters
xmlStream
protected
java.io.InputStream
xmlStream
xslStream
protected
java.io.InputStream
xslStream
Constructors
AbstractDocWriter
public
AbstractDocWriter
()
Methods
AurigaDoclet
API
Document
Pg
-
13
doTransform
public
void
doTransform
(java.io.InputStream
xmlStream,
java.io.InputStream
xslStream,
java.io.OutputStream
outputStream,
java.lang.String
outputMethod,
java.util.Properties
parameters)
throws
java.lang.Exception
Takes
the
xml
source
and
write
the
output
to
the
given
stream
by
doing
an
xsl
transformation.
Parameters:
xmlStream
-
the
xml
stream
xslStream
-
the
xsl
stream
outputStream
-
the
output
stream
outputMethod
-
the
output
method(text,html,xml)
parameters
-
additonal
xsl
parameters
Throws:
java.lang.Exception
-
in
case
of
an
error.
setCssStream
public
void
setCssStream
(java.io.InputStream
cssStream)
Sets
the
css
stream.
Parameters:
cssStream
-
the
css
stream.
setOutputFile
public
void
setOutputFile
(java.lang.String
outputFile)
Sets
the
output
file.
Parameters:
outputFile
-
the
output
file.
AurigaDoclet
API
Document
Pg
-
14
setParameters
public
void
setParameters
(java.util.Properties
params)
Sets
the
parameters.
setXmlStream
public
void
setXmlStream
(java.io.InputStream
xmlStream)
Sets
the
xml
stream.
Parameters:
xmlStream
-
the
xml
stream.
setXslStream
public
void
setXslStream
(java.io.InputStream
xslStream)
Sets
the
xsl
stream.
Parameters:
xslStream
-
the
xsl
stream.
writeDoc
public
abstract
void
writeDoc
()
com.aurigalogic.doclet.writer
Class
CssTreeBuilder
java.lang.Object
|
+--com.aurigalogic.doclet.writer.CssTreeBuilder
<
Constructors
>
<
Methods
>
AurigaDoclet
API
Document
Pg
-
15
public
class
CssTreeBuilder
extends
java.lang.Object
This
class
parses
the
given
css
stream
and
builds
a
xml
tree.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
CssTreeBuilder
public
CssTreeBuilder
(java.io.InputStream
cssStream,
java.lang.String
output)
throws
java.lang.Exception
Constructor.
Parameters:
output
-
the
output
document
Throws:
java.lang.Exception
-
is
an
error
occurs
Methods
getCssTreeFileUrl
public
java.lang.String
getCssTreeFileUrl
()
Returns
the
path
of
the
cssTree
file
Returns:
the
css
tree
file
path
AurigaDoclet
API
Document
Pg
-
16
com.aurigalogic.doclet.writer
Interface
DocWriter
<
Methods
>
public
interface
DocWriter
DocWriter
interface.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Methods
setCssStream
public
void
setCssStream
(java.io.InputStream
cssStream)
Sets
the
css
stream.
Parameters:
cssStream
-
the
css
stream.
setOutputFile
public
void
setOutputFile
(java.lang.String
outputFile)
Sets
the
output
file.
Parameters:
outputFile
-
the
output
file.
AurigaDoclet
API
Document
Pg
-
17
setParameters
public
void
setParameters
(java.util.Properties
params)
Sets
the
parameters.
setXmlStream
public
void
setXmlStream
(java.io.InputStream
xmlStream)
Sets
the
xml
stream.
Parameters:
xmlStream
-
the
xml
stream.
setXslStream
public
void
setXslStream
(java.io.InputStream
xslStream)
Sets
the
xsl
stream.
Parameters:
xslStream
-
the
xsl
stream.
writeDoc
public
void
writeDoc
()
Write
the
output
document.
AurigaDoclet
API
Document
Pg
-
18
com.aurigalogic.doclet.writer
Class
FODocWriter
java.lang.Object
|
+--
AbstractDocWriter
|
+--com.aurigalogic.doclet.writer.FODocWriter
All
Implemented
Interfaces:
DocWriter
Direct
Known
Subclasses:
PDFDocWriter
<
Constructors
>
<
Methods
>
public
class
FODocWriter
extends
AbstractDocWriter
This
class
is
used
for
generating
javadoc
in
FO
format.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
FODocWriter
public
FODocWriter
()
Methods
AurigaDoclet
API
Document
Pg
-
19
createFO
protected
void
createFO
(java.io.InputStream
xmlStream,
java.io.OutputStream
outputStream)
throws
java.lang.Exception
Generates
the
fo
document
Parameters:
in
-
the
xml
stream
out
-
the
fo
output
stream
Throws:
java.lang.Exception
-
in
case
of
an
error.
writeDoc
public
void
writeDoc
()
throws
java.lang.Exception
Converts
the
given
xml
stream
to
fo
and
writes
it
to
the
output
file.
Overrides:
writeDoc
in
class
AbstractDocWriter
Throws:
java.lang.Exception
-
in
case
of
an
error.
AurigaDoclet
API
Document
Pg
-
20
com.aurigalogic.doclet.writer
Class
MIFDocWriter
java.lang.Object
|
+--
AbstractDocWriter
|
+--
FODocWriter
|
+--
PDFDocWriter
|
+--com.aurigalogic.doclet.writer.MIFDocWriter
All
Implemented
Interfaces:
DocWriter
<
Constructors
>
<
Methods
>
public
class
MIFDocWriter
extends
PDFDocWriter
MIF
document
writer.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
MIFDocWriter
public
MIFDocWriter
()
Methods
AurigaDoclet
API
Document
Pg
-
21
writeDoc
public
void
writeDoc
()
throws
java.lang.Exception
Writes
the
javadoc
output
to
the
specified
file.
Overrides:
writeDoc
in
class
PDFDocWriter
Throws:
java.lang.Exception
-
in
case
of
an
error.
com.aurigalogic.doclet.writer
Class
PCLDocWriter
java.lang.Object
|
+--
AbstractDocWriter
|
+--
FODocWriter
|
+--
PDFDocWriter
|
+--com.aurigalogic.doclet.writer.PCLDocWriter
All
Implemented
Interfaces:
DocWriter
<
Constructors
>
<
Methods
>
public
class
PCLDocWriter
extends
PDFDocWriter
PCL
document
writer.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
AurigaDoclet
API
Document
Pg
-
22
PCLDocWriter
public
PCLDocWriter
()
Methods
writeDoc
public
void
writeDoc
()
throws
java.lang.Exception
Writes
the
javadoc
output
to
the
specified
file.
Overrides:
writeDoc
in
class
PDFDocWriter
Throws:
java.lang.Exception
-
in
case
of
an
error.
com.aurigalogic.doclet.writer
Class
PDFDocWriter
java.lang.Object
|
+--
AbstractDocWriter
|
+--
FODocWriter
|
+--com.aurigalogic.doclet.writer.PDFDocWriter
All
Implemented
Interfaces:
DocWriter
Direct
Known
Subclasses:
MIFDocWriter
,
PCLDocWriter
,
PSDocWriter
,
SVGDocWriter
<
Constructors
>
<
Methods
>
public
class
PDFDocWriter
extends
FODocWriter
AurigaDoclet
API
Document
Pg
-
23
PDF
document
generator.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
PDFDocWriter
public
PDFDocWriter
()
Methods
writeDoc
public
void
writeDoc
()
throws
java.lang.Exception
Writes
the
javadoc
output
to
the
specified
file.
Overrides:
writeDoc
in
class
FODocWriter
Throws:
java.lang.Exception
-
in
case
of
an
error.
writeDocUsingFOP
protected
void
writeDocUsingFOP
(int
renderer)
Convert
the
input
stream
to
output
stream
using
the
given
xsl
stream
and
the
renderer.
Parameters:
renderer
-
the
fop
renderer
to
use
AurigaDoclet
API
Document
Pg
-
24
com.aurigalogic.doclet.writer
Class
PSDocWriter
java.lang.Object
|
+--
AbstractDocWriter
|
+--
FODocWriter
|
+--
PDFDocWriter
|
+--com.aurigalogic.doclet.writer.PSDocWriter
All
Implemented
Interfaces:
DocWriter
<
Constructors
>
<
Methods
>
public
class
PSDocWriter
extends
PDFDocWriter
Postscript
document
write.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
PSDocWriter
public
PSDocWriter
()
Methods
AurigaDoclet
API
Document
Pg
-
25
writeDoc
public
void
writeDoc
()
throws
java.lang.Exception
Writes
the
javadoc
output
to
the
specified
file.
Overrides:
writeDoc
in
class
PDFDocWriter
Throws:
java.lang.Exception
-
in
case
of
an
error.
com.aurigalogic.doclet.writer
Class
SVGDocWriter
java.lang.Object
|
+--
AbstractDocWriter
|
+--
FODocWriter
|
+--
PDFDocWriter
|
+--com.aurigalogic.doclet.writer.SVGDocWriter
All
Implemented
Interfaces:
DocWriter
<
Constructors
>
<
Methods
>
public
class
SVGDocWriter
extends
PDFDocWriter
SVG
document
writer.
Author:
Khurshidali
Shaikh
Version:
$Revision:
1.1.1.1
$
$Date:
2003/12/24
12:38:12
$
Constructors
AurigaDoclet
API
Document
Pg
-
26
SVGDocWriter
public
SVGDocWriter
()
Methods
writeDoc
public
void
writeDoc
()
throws
java.lang.Exception
Writes
the
javadoc
output
to
the
specified
file.
Overrides:
writeDoc
in
class
PDFDocWriter
Throws:
java.lang.Exception
-
in
case
of
an
error.
AurigaDoclet
API
Document
Pg
-
27
INDEX
A
AbstractDocWriter
...
12
AbstractDocWriter
...
13
B
BOTTOM_MARGIN
...
3
C
createFO
...
20
cssStream
...
12
COVER_FILE
...
4
COVER_TEXT
...
4
CSS_FILE
...
4
CssTreeBuilder
...
15
CssTreeBuilder
...
16
D
doTransform
...
14
Doclet
...
3
Doclet
...
6
DocWriter
...
17
F
FODocWriter
...
19
FODocWriter
...
19
FOOTER_FILE
...
4
FOOTER_HEIGHT
...
4
FOOTER_TEXT
...
4
FORMAT
...
4
G
generateXML
...
8
getCssTreeFileUrl
...
16
getXMLStream
...
8
getXMLString
...
8
H
HEADER_FILE
...
4
HEADER_HEIGHT
...
5
HEADER_TEXT
...
5
L
log
...
13
LEFT_MARGIN
...
5
M
MIFDocWriter
...
21
MIFDocWriter
...
21
N
NO_INDEX
...
5
NO_LINKS
...
5
NO_NAVIGATION
...
5
NO_TOC
...
5
O
optionLength
...
6
outputFile
...
13
OUTPUT
...
5
OUTPUT_HTML
...
12
OUTPUT_XML
...
12
P
parameters
...
13
PCLDocWriter
...
22
PCLDocWriter
...
23
PDFDocWriter
...
23
PDFDocWriter
...
24
PSDocWriter
...
25
PSDocWriter
...
25
R
readFile
...
9
RIGHT_MARGIN
...
6
S
setCssStream
...
14
setCssStream
...
17
setOutputFile
...
14
setOutputFile
...
17
setParameters
...
15
setParameters
...
18
setXmlStream
...
15
setXmlStream
...
18
setXslStream
...
15
setXslStream
...
18
start
...
6
SVGDocWriter
...
26
SVGDocWriter
...
27
T
tidy
...
10
TOP_MARGIN
...
6
U
Util
...
9
V
validOptions
...
7
W
writeDoc
...
15
writeDoc
...
18
writeDoc
...
20
writeDoc
...
22
writeDoc
...
23
writeDoc
...
24
writeDoc
...
26
writeDoc
...
27
writeDocUsingFOP
...
24
writeFile
...
10
X
xmlStream
...
13
xslStream
...
13
XMLGenerator
...
7
XMLGenerator
...
7
XSL_FILE
...
6