This document discusses how to generate documentation from Java source code comments in different formats like HTML, PDF, RTF using Javadoc and other third party tools. It provides step-by-step instructions on using Javadoc to generate HTML documentation and explains how to use HTMLDOC, PDFDoclet and Docflex-Doclet to convert the Javadoc output into PDF, PDF and RTF formats respectively.

1. Jack Chen

2. How to use it?

3. Generate HTML

4. Step 1

5. Step 2

6. Step 3

7. Step 4

9. Hierachy Tree

11. Navigation Bar

13. Index

15. $ 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

16. $ javadoc

17. Generate PDF

18. • HTMLDOC
• PDFDoclet

19. HTMLDOC
PDF
HTML
HTML
HTML

20. Step 1
$ sudo apt-get install htmldoc
$ htmldoc

21. Step 2

22. Step 3

23. Step 4

25. Page

26. Table of Contents

27. Color

29. Fonts

31. • HTMLDOC
• PDFDoclet

32. PDFDoclet

33. http://sourceforge.net/projects/pdfdoclet/
Step 1

34. 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

36. Configuration
http://pdfdoclet.sourceforge.net/configuration.ht
ml

37. Configuration
http://pdfdoclet.sourceforge.net/configuration.ht
ml

38. Configuration

39. create.links=yes create.links=no

40. Generate RTF

41. • Docflex-Doclet - Free
• Docflex-Javadoc – Limited Fre

42. Step 1
Docflex-Doclet
http://www.filigris.com/downloads/

43. 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

44. Step 3

48. Step 1
http://www.filigris.com/downloads/
Docflex-JavaDoc

49. $ ./designer.sh
Command Line

53. Comparison

54. Doxygen
HTMLDOC
PDFDoclet
Docflex-Doclet

55. Doxygen
HTMLDOC
PDFDoclet
Docflex-Doclet

56. Thanks for your
attention