This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 22728 - Comply with Sun's JavaDoc style recommendations
Summary: Comply with Sun's JavaDoc style recommendations
Status: RESOLVED FIXED
Alias: None
Product: java
Classification: Unclassified
Component: Unsupported (show other bugs)
Version: 3.x
Hardware: PC Windows XP
: P3 blocker (vote)
Assignee: Jan Becicka
URL: http://java.sun.com/j2se/javadoc/writ...
Keywords:
: 22293 (view as bug list)
Depends on: 30669
Blocks:
  Show dependency tree
 
Reported: 2002-04-24 08:55 UTC by cbarham
Modified: 2007-09-26 09:14 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description cbarham 2002-04-24 08:55:27 UTC
the coding guidelines at this URL
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#tag
recommend that the javadoc tags are entered into
source in a set order.  It would be useful if the
AutoComment tool automatically re-ordered tags
that are entered into this recommended order
unless overridden by the user.

There is a related defect on issue tracking with
number 22727.
Comment 1 Marek Grummich 2002-07-19 16:34:51 UTC
Target milestone was changed from not determined to TBD
Comment 2 Milan Kubec 2003-05-06 08:51:40 UTC
Changing to low prio DEFECT since, javadoc code generator should
follow Sun recomendation on how to write docs. Please change Target
Milestone
accordingly.
Comment 3 arittner 2003-05-06 09:10:27 UTC
It could be the same bug: "Tools-> Correct Javadoc" changes the order
of the tags too (only if something incorrect). @return at top. At next
the @param tags (sometimes in wrong order). A leading blank line like
this:

/**
 * DocComment starts here

was changed to

/** DocComment starts here

(there is another related enhancement issue).

greetings,
  josh.
Comment 4 Tomas Zezula 2003-08-27 14:41:26 UTC
NB 4.0 should change the order of tags according to
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#tag
Comment 5 _ pkuzel 2003-09-05 11:05:04 UTC
I'm taking responsibility for JavaDoc module.
Comment 6 _ pkuzel 2003-09-05 14:20:33 UTC
*** Issue 22293 has been marked as a duplicate of this issue. ***
Comment 7 _ pkuzel 2003-09-05 14:21:19 UTC
Issue 22293 except:

If you add a comment to a class or method then the Auto 
Comment tool starts at the very first line, like this:

  /** This is a comment.
   * @param s parameter
   * @return return value
   */  

But it should look like this:

  /** 
   * This is a comment.
   * @param s parameter
   * @return return value
   */  

If you try to workaround this by adding an empty line 
before the comment, then it is correct until you reedit 
the comment at a later time, because then, the blank line 
is being converted to a space.
Comment 9 _ pkuzel 2004-03-24 10:47:35 UTC
[batch] Giving up javadoc issues exclusive ownership.
Comment 10 Jan Becicka 2004-07-23 16:07:29 UTC
Fixed by new JMI based java module.
Comment 11 Quality Engineering 2007-09-20 12:08:13 UTC
Reorganization of java component