Javadoc study and presentation

Jack Chen

How to use it?

Generate HTML

Step 1

Step 2

Step 3

Step 4

Hierachy Tree

Navigation Bar

Index

$ javadoc -d “Destination directory for output files” \

-sourcepath "Specify where to find source files” \

“package names”

Command Line

$ javadoc -d "/home/jackchen/桌面/javadoc_html/" \

-sourcepath “/home/jackchen/桌面/project/SiME_Service/SiMESpeech/SiMESpeechLibrary/mylibrary/src/main/java/

“ \

com.chipsip.speech

Example

$ javadoc

Generate PDF

• HTMLDOC

• PDFDoclet

HTMLDOC

PDF

HTML

HTMLHTML

Step 1

$ sudo apt-get install htmldoc

$ htmldoc

Step 2

Step 3

Step 4

Page

Table of Contents

Color

Fonts

• HTMLDOC

• PDFDoclet

PDFDoclet

http://sourceforge.net/projects/pdfdoclet/

Step 1

Javadoc \

-doclet "Generate output via alternate doclet" \

-docletpath "Specify where to find doclet class files" \

-pdf "The path of the created PDF file" \

-config "Specify where to find config file" \

-sourcepath "Specify where to find source files“ \

“package names”

Command Line

javadoc \

-doclet "com.tarsec.javadoc.pdfdoclet.PDFDoclet" \

-docletpath "./jar/pdfdoclet-1.0.3-all.jar" \

-pdf "/home/jackchen/桌面/doc/pdfdoclet-1.0.3.pdf" \

-config "example/laby/config_laby.properties" \

-sourcepath "/home/jackchen/桌面/project/SiME_Service/SiMESpeech/SiMESpeechLibrary/mylibrary/src/main

/java/" \

“com.chipsip.speech”

Example

Step 2

Package name

Configuration

http://pdfdoclet.sourceforge.net/configuration.ht

ml

Configuration

http://pdfdoclet.sourceforge.net/configuration.ht

ml

Configuration

create.links=yes create.links=no

Generate RTF

• Docflex-Doclet - Free

• Docflex-Javadoc – Limited Free

Step 1

Docflex-Doclet

http://www.filigris.com/downloads/

javadoc -doclet "Generate output via alternate doclet" \

-docletpath "Specify where to find doclet class files" \

-docflexconfig "Specify where to find config file" \

-d “Destination directory for output files” \

-sourcepath "Specify where to find source files“ \

“package names”

Command Line

javadoc -doclet com.docflex.javadoc.Doclet \

-docletpath "/home/jackchen/桌面/docflex-doclet-1.6.1/lib/docflex-doclet.jar" \

-docflexconfig "/home/jackchen/桌面/docflex-doclet-1.6.1/linux/docflex.config" \

-d "/home/jackchen/桌面/doc/" \

-sourcepath "/home/jackchen/桌面/project/SiME_Service/SiMESpeech/SiMESpeechLibrary/mylibrary/src/main/java/“

"com.chipsip.speech"

Example

Step 2

Package name

Step 3

Step 1

http://www.filigris.com/downloads/

Docflex-JavaDoc

$ ./designer.sh

Command Line

Comparison

Doxygen

HTMLDOC

PDFDoclet

Docflex-Doclet

Doxygen

HTMLDOC

PDFDoclet

Docflex-Doclet

Thanks for your

attention