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 80013 - javadoc for Retriever.retrieveResource does not describe use of catalog
Summary: javadoc for Retriever.retrieveResource does not describe use of catalog
Status: VERIFIED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: XML (show other bugs)
Version: 6.x
Hardware: All All
: P3 blocker (vote)
Assignee: Girish Balachandran
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-07-11 17:43 UTC by Chris Webster
Modified: 2006-10-23 15:47 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 2006-07-11 17:43:21 UTC 
In fact this method creates (and writes entries to) catalog.xml file located
under the project's root. The catalog can be used later, and we actually do
that, to work with local resources instead of the remote ones. The javadoc must
reflect the interaction with the catalog.
Comment 1 Chris Webster 2006-07-11 17:55:55 UTC 
The javadoc also needs to describe how to mutate the catalog using the
CatalogWriteModel api. There is currently no javadoc on the Retriever class, so
this javadoc could include the related classes like the CatalogWriteModel. 

I also see that the Retriever returns File from getProjectCatalog() should this
be FileObject.
Comment 2 Girish Balachandran 2006-08-23 02:53:43 UTC 
Changed the comments as suggested.
Comment 3 Chris Webster 2006-09-23 16:09:54 UTC 
verified