Java_api Document Generation

This article describes the use of the cmd command to generate API documentation for files in Java Engineering in a windows environment;

One, project source files for the "engineering" level

1. Create a new text file: Package.txt, List all package names as follows

Org.eclipse.swtorg.eclipse.swt.accessibilityorg.eclipse.swt.awtorg.eclipse.swt.browserorg.eclipse.swt.customorg.eclipse.s Wt.dndorg.eclipse.swt.eventsorg.eclipse.swt.graphicsorg.eclipse.swt.internalorg.eclipse.swt.internal.gdiporg.eclipse.swt . internal.imageorg.eclipse.swt.internal.mozillaorg.eclipse.swt.internal.mozilla.initorg.eclipse.swt.internal.ole.win32org . eclipse.swt.internal.opengl.win32org.eclipse.swt.internal.themeorg.eclipse.swt.internal.win32org.eclipse.swt.layoutorg.e Clipse.swt.ole.win32org.eclipse.swt.openglorg.eclipse.swt.printingorg.eclipse.swt.programorg.eclipse.swt.widgets

View Code

2. Tip: shift+ The right mouse button, "Open command Window Here", enter the cmd window, enter the following command:

javadoc-d API @package. txt

　　Note: The API represents the directory name of the Help document, @package. txt indicates that the package name is passed in as a file;

　　3. After execution, the API folder is generated, with the following directories inside:

　　

Ii. Examples of common commands (generate individual files or separate directory APIs)

1 // working with a single source file 2 // handling a single package 3 // handle multiple packages, and if you handle fewer packages, you can use the direct input method 4 Javadoc-private -D API@ Package// process multiple packages. Generate the most complete help document, including properties and methods with the private modifier

Note: This article makes the API method, applies to all Java open source projects, as long as the source code can be.

Reference Documentation:

Http://blog.sina.com.cn/s/blog_6d5c82a70100omah.html

　　　　

　　　　

Java_api Document Generation