Scribd
Upload
16 views

Java

The document provides instructions for using the javadoc command to generate API documentation from Java source code. It explains that you first need to change to the directory containing the .java file using the cd command. Then you can generate documentation by running javadoc, specifying the -d option to set the output directory and the class file name. If your code uses custom tags, you need to define them using the -tag option for javadoc to recognize them.

Uploaded by

yousuff
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
16 views

Java

The document provides instructions for using the javadoc command to generate API documentation from Java source code. It explains that you first need to change to the directory containing the .java file using the cd command. Then you can generate documentation by running javadoc, specifying the -d option to set the output directory and the class file name. If your code uses custom tags, you need to define them using the -tag option for javadoc to recognize them.

Uploaded by

yousuff
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

How to use javadoc command

January 19, 2011


Suppose you have created a project in Eclipse in C:\.....\src and the class is called BankAccount1. To use the javadoc command, open a terminal or command prompt. Change your directory to C:\....\src where your class le is using the cd command. For example, if you are in C:\paria you can change your directory to C:\paria\Lab02\src using the command cd Lab02\src This example is shown in gure 1. Note that we were rst in C:\paria and then changed to C:\paria\Lab02\src using the command above.

Figure 1: cd command Suppose you want to use javadoc for creating the API of your class which is called BankAccount1.java. You can use the command javadoc -d doc BankAccount1.java This command will create a new folder called doc and put the API les in this new folder. See Figure 2 for an example.

Figure 2: Javadoc command If you have new tags, you should inform javadoc about them. Then you can use the command below, see gure 3. javadoc -tag newTag.:a:New Tag: -d doc BankAccount1.java

For example, if your new tag is pre, the command above will be: javadoc -tag pre.:a:Precondition: -d doc BankAccount1.java

Figure 3: new tag recognition

You might also like