Javadoc for private methods (BlueJ)

I'm using BlueJ and I want to generate Javadoc for the whole project

Solution

This link indicates that BlueJ will only generate Javadoc for public methods and classes

However, according to the bug report associated with Andrew Thompson's answer, it seems that this is already in BlueJ 1.1 Fixed in version 5 In fact, according to section 9.8 of the BlueJ reference manual, you can edit the doctool Options attribute to specify exactly the options to use when running Javadoc tools

There seem to be three properties that control the behavior of document generation:

> doctool. Command: controls the command used to generate documents. By default, it is set to Javadoc > doctool Outputdir: controls the location where the generated document is saved. By default, it is set to doc > doctool Options: control is passed to Javadoc Other command line options of the command specified by command. The default setting is - Author - version - nodeprecised - package Note that you can record all methods by replacing - package with - private

Generally, since Javadoc tool is a command line program, you can call it yourself from the command line, as shown below:

$javadoc -d \path\to\output\folder -sourcepath \path\to\source\folder -private

Note that this command assumes that Javadoc is included in the path environment variable, which is usually the case in most Java installations

>The - D option provides the required output Directory > - sourcepath option tells the Javadoc tool where to find the source code to record > - private option tells the Javadoc tool to create documents for all classes, members and methods (because private is the most restricted visibility)

The complete list of options to control the members that Javadoc will record is:

>- public – only public classes and members are displayed. >- Protected – only protected public classes and members are displayed This is the default. >- Package – displays only packages, protected and public classes and members. >- Private – displays all classes and members

(from Javadoc documentation)

Editor 0: updated the answer to include the new information exposed by Andrew Thompson in