Skip to main content

More JavaDoc options please

1 reply [Last post]
Joined: 2003-06-29

It would be great if JavaDoc allowed to choose visibility (public/protected/private) separately for fields and methods

The reason is that in some cases I need to document fields which are private but I do not want any other non-public members to appear in my doc. Specifically in my persistent models (JDO) I need to document all persistent fields and I have no way of doing it without exposing all other non-public members

If only Java had explicit properties like C# or Delphi do it would make our life so much easer in many many cases (for example covariant return types break JavaBean pattern - explicit property definition would take care of the problem)

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Joined: 2005-01-12

It would be nice to do some fairly simple things in the default doclet.

For example, can method names show up in the documentation in sorted order? A parameter which took the name of a class which implements java.util.Comparator, that could be used for the sorting, would be a welcome addition.

Also, there is an -exclude option which takes a list of packages, but it would be helpful to have an -excludePattern which would take a string, or perhaps a regex. If a package name, class name, method name, or ivar name matched it, it would be excluded.

These are fairly simple tasks. I am sure I am not the only one who has wished for these. Writing a custom doclet for just these features is a very heavy cost.