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 35454 - JavaProject Documentation is not sufficient
Summary: JavaProject Documentation is not sufficient
Status: CLOSED WONTFIX
Alias: None
Product: java
Classification: Unclassified
Component: Unsupported (show other bugs)
Version: 3.x
Hardware: Sun SunOS
: P1 blocker (vote)
Assignee: Svata Dedic
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-08-15 22:37 UTC by Chris Webster
Modified: 2007-09-26 09:14 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Webster 2003-08-15 22:37:07 UTC 
Documentation for JavaProject api is lacking in
many areas for example several overrides of
createCompilationUnit lack javadoc altogether. The
documentation should also include an overview
section which discusses the intended interaction
for projects which use the java nature as a basis.
Specifically, the recommended approach for
initializing the generic project (where another
wizard is the user interaction point).
Comment 1 Svata Dedic 2003-08-17 07:09:39 UTC 
I will look at this (add javadoc, improve overview), but I do not
understand the "recommended approach...." sentence -- java project is
not a generic project (that's IdeProject). Were you looking for a
paragraph like "if you want to populate a project with java stuff from
scratch, do this, this and that" ?

BTW the api.java.project has already an overview page, linked from the
pacakge overview table (see the link in the paragraph at the end of
the page). If unhappy with style/content/structure, feel free to say
what is missing/wrong.
Comment 2 John Jullion-ceccarelli 2003-08-18 09:49:07 UTC 
Reassigning to developers as this is dev docs issue
Comment 3 John Jullion-ceccarelli 2003-08-18 09:49:51 UTC 
sorry... should look at the post before I reassign :-)
Comment 4 Vitezslav Stejskal 2003-11-24 16:03:41 UTC 
As described in
http://www.netbeans.org/servlets/ReadMsg?msgId=619519&listName=nbdiscuss the
current work on projects prototype has been stopped.
Comment 5 Jan Becicka 2003-11-25 13:46:11 UTC 
Marking issue as VERIFIED --->
Comment 6 Jan Becicka 2003-11-25 13:50:59 UTC 
---> CLOSED
Comment 7 Quality Engineering 2007-09-20 11:58:14 UTC 
Reorganization of java component