Pre-Requisites:
- jdk1.6.0_11
Installed location:
jdk1.6.0_11 -> C:\Program Files\Java\jdk1.6.0_11\
Environment Variables:
Enter Variable name and Variable value which is mentioned below.
| Variable name: | JAVA_HOME |
| Variable value: | C:\Program Files\Java\jdk1.6.0_11 |
Overview:
Javadoc is a tool for generating API Documentation in HTML format from doc comments in source code.
Save as CreateJavadocExample.java
- /*
- * @(#)CreateJavadocExample.java 1.0 07/15/09
- *
- * Copyright 2009 Java Workspace, Inc. All rights reserved.
- * JAVA WORKSPACE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
- package com.javaworkspace.javadoc;
- /**
- * The class <code>CreateJavadocExample</code> includes method for adding two
- * numbers
- *
- * <p>
- * For additional information on Javadoc, see <a *="" href="http://www.javaworkspace.com/createJavaDoc.do">http://www.javaworkspace.com/createJavaDoc.do</a>.
- * </p>
- *
- * @author www.javaworkspace.com
- * @version 1.0, 07/15/09
- * @see java.lang.Object
- * @since 1.0
- */
- public class CreateJavadocExample {
- /**
- * @param a
- * first number which is to be added
- * @param b
- * second number which is to be added
- * @return addition of two numbers
- * @since 1.0
- */
- public int add(int a, int b) {
- return a + b;
- }
- }
Steps To Create JavaDoc
- Copy the above program in the folder com.javaworkspace.javadoc
- In command prompt navigate to D:\javadoc\com\javaworkspace\javadoc>
- type javadoc CreateJavadocExample.java
- this will create html document in the same folder.
- Locate index.html and click that.
- Browser window will be opened with Class Summary.
- Click CreateJavadocExample in top left corner of All Classes pane.
- You can see Method Detail, Detail... etc.
- In the above example we have mentioned only some of the javadoc comments.
