Project: Eclipse_Platform_UI
Bug 58913 [Progress] [Javadoc] Review of "org.eclipse.ui.progress"
Reported: 2004-04-16 15:10:15 | Status: closed fixed

WARNINGS: -------- DeferredTreeContentManager.java:48: warning - @param argument "partSite" is not a parameter name. DeferredTreeContentManager.java:133: warning - @param argument "parent." is not a parameter name. DeferredTreeContentManager.java:300: warning - @param argument "parent." is not a parameter name. IProgressService.java:47: warning - @deprecated. is an unknown tag. IWorkbenchSiteProgressService.java:49: warning - @param argument "job." is not a parameter name. IWorkbenchSiteProgressService.java:49: warning - @param argument "delay." is not a parameter name. IWorkbenchSiteProgressService.java:49: warning - @param argument "useHalfBusyCursor." is not a parameter name. IWorkbenchSiteProgressService.java:60: warning - @param argument "job." is not a parameter name. IWorkbenchSiteProgressService.java:60: warning - @param argument "delay." is not a parameter name. IWorkbenchSiteProgressService.java:70: warning - @param argument "job." is not a parameter name. ADDITIONAL COMMENTS: ------------------- + No package overview IDeferredWorkbenchAdapter + marked as experimental and subject to change. Is this intentional? + Give a concrete example of how it is used + in "fetchDeferredChildren", "should return notify" makes no sense + what should the implementors do if the progress monitor is cancelled? + what is object? What possible things could I expect it to be? can this be null? + can collector be null? + in "isContainer", the @returns sentence doesn't make sense. what rule? + in "getRule", can object be null? + can the scheduling rule be null? + the scheduling rule is obviously an instance of ISchedulingRule DeferredTreeContentManager + in "DeferredTreeContentManager(provider,viewer,site)", no param doc + in "DeferredTreeContentManager(provider,viewer)", no param doc + mayHaveChildren is missing param doc + mayHaveChildren should use @throws instead of commenting in the method doc + mayHaveChildren returns boolean? thanks. + getChildren second sentence is not grammatically correct + in general, this class is missing real information in param/returns. either there's nothing or things like "returns Object[]". it's also nice to be explicit about null vs. not null vs. possibly empty. + "startFetchingDeferredChildren" - "retrieve" should be "retrieved" + "runClearPlaceholderJob" why would I want to do this? what does it mean? + in general, element collector is bit foggy. one or two sentences in the class summary would help (providing a link for more info). This is a work in progress. More stuff to appear over the weekend.

Files changed in fix:
bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/DeferredTreeContentManager.java bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IDeferredWorkbenchAdapter.java bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IElementCollector.java bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IProgressService.java bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IWorkbenchSiteProgressService.java bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/UIJob.java bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/WorkbenchJob.java