Feature Requests item #878674, was opened at 2004-01-17 02:45
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=438938&aid=878674&group_id=44253
Category: Javadoc integration
Group: Small (< 1 pair-week)
Status: Open
Priority: 5
Submitted By: Charles Reis (csreis)
Assigned to: Charles Reis (csreis)
Summary: More Javadoc tags by default
Initial Comment:
Story:
User writes a new class, and specifies @author and
@version tags in the Javadoc comments. She clicks the
Javadoc button in her newly downloaded copy of DrJava,
and the generated web pages include information about
the author and version.
Notes:
The author and version tags are disabled by default in
the Javadoc tool, unless "-author" and "-version" are
passed as command line arguments. These can be
specified in the DrJava preferences, but are not
enabled by default. I'm of the opinion that DrJava
should turn these on by default, since they're
generally useful tags and good for demonstration
purposes in intro classes. Plus, having the default
value of the preference be "-author -version" gives
users a better feel for what type of information is
expected in that field.
Are there other arguments that would be good to enable
by default? Or is there a reason *not* to enable these
by default? (Most common tags, like @param, @return,
@throws , and @see, all work by default.)
----------------------------------------------------------------------
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=438938&aid=878674&group_id=44253
|