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 96250 - "Missing Javadoc" on main methods
Summary: "Missing Javadoc" on main methods
Status: RESOLVED FIXED
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 6.x
Hardware: All All
: P4 blocker (vote)
Assignee: Jan Pokorsky
URL:
Keywords:
Depends on:
Blocks: 89603
  Show dependency tree
 
Reported: 2007-02-22 01:31 UTC by Jesse Glick
Modified: 2007-09-14 10:10 UTC (History)
0 users

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 Jesse Glick 2007-02-22 01:31:18 UTC
Methods which signature is

  public static void main(String[] _)

are almost certainly intended to be application entry points, so they don't
generally need Javadoc. Probably the "Missing Javadoc" warning/hint should be
disabled for such methods.

Visible when you create a new main class.
Comment 1 Jan Pokorsky 2007-02-22 11:09:47 UTC
I want to rewrite the missing javadoc hint to the new hints api from jlahoda so
it will not be a warning but a hint visible just in case you place the caret in
a method signature by default. He plans options ui to customize this. I will
look at it as time permits.

BTW an easy fix of this could be to add javadoc to the template. I am not sure
that omitting documentation of entry point arguments is a good idea. Is not it
api contract between cmd line and the app? ;-)
Comment 2 Jan Pokorsky 2007-09-10 16:12:01 UTC
It is customizable now.
Comment 3 Jesse Glick 2007-09-13 23:10:39 UTC
What is customizable? I don't see any option in a dev build relating to main methods.
Comment 4 Jan Pokorsky 2007-09-14 10:10:19 UTC
You can customize in Tools/Options if use JD hints at all, what scope should be analyzed (public, private, ...) and how
it should be presented (error, warning, caret on line, ...). The same is valid for the main method. There is no plan to
list such detailed options.