How to make documentation with NetBeans and Javadoc

Question

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.

u want to generate javadoc HTML files? – Raj Dec 13 '11 at 17:30 — Raj, Dec 13 '11 at 17:30

score 57 · Accepted Answer · answered Dec 13 '11 at 17:33

57

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

Netbeans generate javadoc

answered Dec 13 '11 at 17:33

Raj

22,346
14
99
142

2

Thanks, but how can i do it only for 1 file? – Piotr Łużecki Dec 13 '11 at 17:37
That is not possible, I think. But once it generates for all the classes, goto your project folder/dist/javadoc/package-name and open the HTML of your required class – Raj Dec 13 '11 at 17:55
How can I view the document after it has been created? – John Hogan Jul 31 '14 at 10:06
@JohnHogan Open the generated HTML file in your browser – Raj Aug 04 '14 at 14:38

score 17 · Answer 2 · answered Jun 07 '15 at 17:52

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 :)

score 7 · Answer 3 · answered Apr 07 '15 at 01:08

7

This is another way that you can generate your Javadoc through Netbeans.

1.- Click on 'Run' menu

2.- Then go down to 'Generate Javadoc (...)'

enter image description here

answered Apr 07 '15 at 01:08

S. Mayol

2,565
2
27
34

Where is the resulting HTML document stored? – kurdtpage Aug 12 '17 at 03:03
@kurdtpage It's in the project's "dist" folder. – scgrn Sep 07 '17 at 18:43

How to make documentation with NetBeans and Javadoc

3 Answers3

Linked