Search code examples
javaincludejavadocprivate

Java Javadoc include Private


I would like to generate javadocs for my application and i would also like to include private members.

I have found the following in the Javadoc documentation

       -private
           Shows all classes and members.

Could you please help me by giving an example of the execution of this?

It should be something like: javadoc -private .... I need to know how to provide the root directory and destination directory for the generated html doc files.

thank you.

EDIT: i found a way to generate javadoc from NetBeans 6.8. this is as follows:

NetBeans Java projects typically have a parameter for this in the project’s properties section. You can right-click the project name in the Projects Window and select Properties. In the Project Properties window that appears, the Documenting node contains a checkbox field labeled ‘Include Private and Package Private Members’.

i found this here

seems to generate docs as desired. thank you everyone.


Solution

  • From the command line, it says

    javadoc [options] [packagenames] [sourcefiles] [@files]
    

    So it would be something like:

    javadoc -private -d output/directory -sourcepath src/java
    

    But you may also take a look to the javadoc documentation and this section.