Bug 269813 - document the fact that getZip returns an open zipreader. patch by Nickolay Ponomarev <asqueella@gmail.com>, r=darin, sr=bz.

git-svn-id: svn://10.0.0.236/trunk@194462 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
mozilla.mano%sent.com 2006-04-15 13:59:31 +00:00
parent 3cfd8116a5
commit 655a88ea21

View File

@ -209,6 +209,14 @@ interface nsIZipReaderCache : nsISupports
/**
* Returns a (possibly shared) nsIZipReader for an nsIFile.
*
* If the zip reader for given file is not in the cache, a new zip reader
* is created, initialized, and opened (see nsIZipReader::init and
* nsIZipReader::open). Otherwise the previously created zip reader is
* returned.
*
* @note If someone called close() on the shared nsIZipReader, this method
* will return the closed zip reader.
*/
nsIZipReader getZip(in nsIFile zipFile);
};