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
– Raj

2011-12-13 17:30:52 +00:00
Commented Dec 13, 2011 at 17:30 — Raj
– Raj, Commented Dec 13, 2011 at 17:30

Raj · Accepted Answer · 2011-12-13 17:33:03Z

58

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

Netbeans generate javadoc

answered Dec 13, 2011 at 17:33

Raj

23.1k14 gold badges105 silver badges148 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Piotr Łużecki Over a year ago

Thanks, but how can i do it only for 1 file?

Raj Over a year ago

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

John Hogan Over a year ago

How can I view the document after it has been created?

Raj Over a year ago

@JohnHogan Open the generated HTML file in your browser

RominaV · Accepted Answer · 2015-06-07 17:52:18Z

18

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

answered Jun 7, 2015 at 17:52

RominaV

3,4351 gold badge33 silver badges59 bronze badges

Comments

S. Mayol · Accepted Answer · 2015-04-07 01:08:46Z

8

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 7, 2015 at 1:08

S. Mayol

2,6553 gold badges31 silver badges37 bronze badges

3 Comments

kurdtpage Over a year ago

Where is the resulting HTML document stored?

scgrn Over a year ago

@kurdtpage It's in the project's "dist" folder.

Alonso del Arte Dec 7, 2024 at 16:35

That threw me off. I was expecting the doc folder.

Collectives™ on Stack Overflow

How to make documentation with NetBeans and Javadoc

3 Answers 3

4 Comments

Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

4 Comments

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related