Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to make documentation with NetBeans and Javadoc

I was searching a while, but nothing found. How can i make documentation in NetBeans 7.0.1?

My file looks like:

/** Class Description of MyClass */ public class ScanReader{ } 

In my project properties i checked all options with checkbox and nothing in Javadoc options (i tried -d with global path, but nothing happened). When i make build or build and clean i dont see anything about documentation and nothing new in project file either.

like image 569
Piotr Łużecki Avatar asked Dec 13 '11 17:12

Piotr Łużecki


People also ask

How do you generating Javadoc in NetBeans?

To generate Javadoc for a project, select Run > Generate Javadoc from the menu bar or, right-click the project in the Projects window and choose Generate Javadoc. The IDE will generate the Javadoc and open it in a separate browser window.

How do I document a Javadoc?

From the main menu, select Tools | Generate JavaDoc. In the dialog that opens, select a scope — a set of files or directories for which you want to generate the reference, and set the output directory where the generated documentation will be placed.


2 Answers

Right click your project in Project window and click 'Generate Javadoc'

Netbeans generate javadoc

like image 129
Lenin Raj Rajasekaran Avatar answered Oct 16 '22 10:10

Lenin Raj Rajasekaran


Update: for those using NetBeans 8.0, besides the options already stated, you can create Javadoc for a file or package.

  • Right click over file/package
  • Tools > Analyze Javadoc
  • "Analyzer" window should appear, noting which Javadoc is missing, with the corresponding "Create missing Javadoc for [method]"
  • Check the ones you want, click on "Fix Selected".

Done :)

like image 34
RominaV Avatar answered Oct 16 '22 09:10

RominaV