JAVADOC for private methods (BlueJ)

Question

I am using BlueJ and I would like to create a Javadoc for my entire project. I would like to show private methods in Javadoc, is there any way to do this? BlueJ has a tool that makes Javadoc, but BlueJ ignores private methods. Is this just a convention? If this is an agreement, I don’t understand why they ignore the "internal" methods, they are also useful. - *

Answer 1

This link assumes that BlueJ will only generate JavaDocs for public methods and classes. In particular:

your output will contain information about public methods and variables

However, consistent with this bug report , related to Andrew Thompson's answer , it seems this has been fixed in version 1.1.5 of BlueJ. In fact, according to section 9.8 of the JavaDoc documentation )

EDIT 0: Updated answer to include new information revealed by Andrew Thompson

Answer 2

As a rule, people do not put private methods in Javadoc, because Javadoc is for someone who uses your code. Since they cannot access private methods, it makes no sense to document them for this audience.

However, a flag is provided for the javadoc tool:

javadoc -private 

Will generate private methods in your Javadoc. I'm not sure how BlueJ works with this, but maybe you can pass a flag or something like that.

Answer 3

The link in the accepted answer is written in an article written in 2001. Since then, much has changed.

eg. Hunting down through the top 5 or so links for "bluej + javadocs" includes a link to what the error report mentions for allowing you to include private methods in javadoc . The description mentions:

set user-defined javadoc parameters (in bluej.defs) so that users can include private methods in the documentation

Also mentioned:

 Resolution: FIXED 

---

Note. I do not use BlueJ, but I had to go hunting when I heard the incredible answer that the main IDE is not able to offer the configuration of such a simple thing.