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 44802 - Incomplete API documentation
Summary: Incomplete API documentation
Status: VERIFIED FIXED
Alias: None
Product: debugger
Classification: Unclassified
Component: Code (show other bugs)
Version: 4.x
Hardware: PC Windows ME/2000
: P2 blocker (vote)
Assignee: issues@debugger
URL:
Keywords: API
Depends on:
Blocks: 42779
  Show dependency tree
 
Reported: 2004-06-14 09:19 UTC by Tomas Pavek
Modified: 2006-07-28 15:33 UTC (History)
0 users

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 Tomas Pavek 2004-06-14 09:19:57 UTC 
Several issues found during the review of the
Debugger APIs.

(1) Describe clearly how the (JPDA) debugger is
started and how the exceptions should be handled.
In DebuggerJPDA-API/apichanges.html it is stated
that JPDADebugger.getException() was added to
inform about problems during debugger start
(asynchronous). This is a bit misleading since the
method was removed later when support for
synchronous start was added
(JPDADebugger.waitRunning()).

(2) Provide a description of creating and
processing JPDABreakpointEvent event. The current
JavaDoc for JPDABreakpointEvent is too brief.
According to API changes from May 11th, four new
methods were added, but it is not clear why (e.g.
what is resume() method good for in an event
object?). It seems JPDABreakpointEvent may serve
to more breakpoint types and different purposes.

(3) ActionsManager javadoc needs update. JavaDoc
for ActionsManager and DebuggerEngine in Debugger
Core API is almost the same. Also the advertised
action constants should be in ActionsManager
(mentioned n API changes April 29th).

(4) Describe clearly the difference between
ContextProvider and EngineContextProvider from
Debugger JPDA API. They have the same summary in
JavaDoc ("Provides editor, source and classpath
context for debugging.").
Comment 1 Jan Jancura 2004-06-17 16:43:59 UTC 
add 1) JPDADebugger.getException () has been replaced by
JPDADebugger.waitRunnig (). This method has JavaDoc comment.

add 2) JavaDoc has been updated.

add 3) JavaDoc has been updated.

add 4) JavaDoc has been updated.

Fixed in the main trunk:
Checking in api/src/org/netbeans/api/debugger/ActionsManager.java;
/cvs/debuggercore/api/src/org/netbeans/api/debugger/ActionsManager.java,v
 <--  ActionsManager.java
new revision: 1.6; previous revision: 1.5
done
Checking in api/src/org/netbeans/api/debugger/DebuggerEngine.java;
/cvs/debuggercore/api/src/org/netbeans/api/debugger/DebuggerEngine.java,v
 <--  DebuggerEngine.java
new revision: 1.7; previous revision: 1.6
done
Checking in
api/src/org/netbeans/api/debugger/jpda/JPDABreakpointEvent.java;
/cvs/debuggerjpda/api/src/org/netbeans/api/debugger/jpda/JPDABreakpointEvent.java,v
 <--  JPDABreakpointEvent.java
new revision: 1.3; previous revision: 1.2
done
Checking in api/src/org/netbeans/api/debugger/jpda/JPDADebugger.java;
/cvs/debuggerjpda/api/src/org/netbeans/api/debugger/jpda/JPDADebugger.java,v
 <--  JPDADebugger.java
new revision: 1.12; previous revision: 1.11
done
Processing log script arguments...
More commits to come...
Checking in api/src/org/netbeans/spi/debugger/jpda/ContextProvider.java;
/cvs/debuggerjpda/api/src/org/netbeans/spi/debugger/jpda/ContextProvider.java,v
 <--  ContextProvider.java
new revision: 1.12; previous revision: 1.11
done
Checking in
api/src/org/netbeans/spi/debugger/jpda/EngineContextProvider.java;
/cvs/debuggerjpda/api/src/org/netbeans/spi/debugger/jpda/EngineContextProvider.java,v
 <--  EngineContextProvider.java
new revision: 1.6; previous revision: 1.5
done
Comment 2 Jiri Kovalsky 2006-07-28 15:33:01 UTC 
I believe Tomas is satisfied with javadoc now thus verifying on his behalf.