[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677

[cblu]

The following commit has been merged in the debian/unstable branch:
commit 53075e2d9d773cc132e2370f7091c648957ae65d
Author: cblu <cblu at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date:   Sat Mar 8 02:02:49 2003 +0000

    	Updated header doc comments.
    
            * Downloads.subproj/WebDownload.h:
    
    
    git-svn-id: http://svn.webkit.org/repository/webkit/trunk@3783 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index 30b9dfe..4358baf 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,9 @@
+2003-03-07  Chris Blumenberg  <cblu at apple.com>
+
+	Updated header doc comments.
+
+        * Downloads.subproj/WebDownload.h:
+
 2003-03-07  Richard Williamson   <rjw at apple.com>
 
         Drop mainDocumentError from WebDataSource.
diff --git a/WebKit/Downloads.subproj/WebDownload.h b/WebKit/Downloads.subproj/WebDownload.h
index 247215e..67ca8cf 100644
--- a/WebKit/Downloads.subproj/WebDownload.h
+++ b/WebKit/Downloads.subproj/WebDownload.h
@@ -7,36 +7,50 @@
 
 #import <Foundation/Foundation.h>
 
- at class WebDownload;
 @class WebDownloadPrivate;
 @class WebError;
 @class WebRequest;
 @class WebResponse;
 
+ at protocol WebDownloadDecisionListener;
+
 /*!
-    @protocol WebDownloadDecisionListener
-    @discussion An object that conforms to the WebDownloadDecisionListener protocol is passed
-    with the download:decidePathWithListener: method of the WebDownloadDelegate protocol. There is
-    no need to directly create an object that conforms to this protocol.
+    @class WebDownload
+    @discussion A WebDownload loads a request and saves the resource to a file. The progress of the download
+    is reported via the WebDownloadDelegate protocol. Note: The word "download" is used to refer to the process
+    of loading data off a network, decoding the data if necessary and saving the data to a file.
 */
- at protocol WebDownloadDecisionListener <NSObject>
+ at interface WebDownload : NSObject
+{
+    @private
+    WebDownloadPrivate *_private;
+}
+
 /*!
-    @method setPath:
-    @abstract This method should be called when the path of the downloaded file has been decided.
-    @param path The path of the downloaded file.
-    @discussion If necessary, to avoid overwriting files, "-n" will be appended to the filename before the
-    extension where "n" is a number. Because of this, use the path passed with download:didCreateFileAtPath:
-    on WebDownload when referring to the path of the downloaded file, not the path set with this method.
+    @method initWithRequest:
+    @abstract Initializes a WebDownload object.
+    @param request The request to download. Must not be nil.
 */
--(void)setPath:(NSString *)path;
+- initWithRequest:(WebRequest *)request;
+
+/*!
+    @method loadWithDelegate:
+    @abstract Starts the download.
+    @param delegate The delegate of the download. Must not be nil.
+*/
+- (void)loadWithDelegate:(id)delegate;
+
+/*!
+    @method cancel
+    @abstract Cancels the download and deletes the downloaded file.
+*/
+- (void)cancel;
 
 @end
 
 /*!
     @protocol WebDownloadDelegate
-    @discussion The delegate of a WebDownload can conform to the WebDownloadDelegate protocol.
-    The delegate is primarily used to report the progress of the download. Note: The word "download" is used to
-    refer to the process of loading data off a network, decoding the data if necessary and saving the data to a file.
+    @discussion The WebDownloadDelegate delegate is primarily used to report the progress of the download.
 */
 @interface NSObject (WebDownloadDelegate)
 
@@ -57,15 +71,16 @@
     that will be used to continue loading the request, and modify it if necessary.
     @param download The download that will send the request.
     @param request The request that will be used to continue loading.
-    @result The request to be used; either the request parameter or a replacement.
+    @result The request to be used; either the request parameter or a replacement. If nil is returned,
+    the download is cancelled.
 */
 - (WebRequest *)download:(WebDownload *)download willSendRequest:(WebRequest *)request;
 
 /*!
     @method download:didReceiveResponse:
-    @abstract This method is called when the download has received enough information to contruct a WebResponse.
+    @abstract This method is called when the download has received a response from the server.
     @param download The download that now has a WebResponse available for inspection.
-    @param response The WebResourceResponse object for the given download.
+    @param response The WebResponse object for the given download.
 */
 - (void)download:(WebDownload *)download didReceiveResponse:(WebResponse *)response;
 
@@ -133,35 +148,20 @@
 @end
 
 /*!
-    @class WebDownload
-    @discussion A WebDownload loads a request and saves the resource to a file. The progress of the download
-    is reported via the WebDownloadDelegate protocol. Note: The word "download" is used to refer to the process
-    of loading data off a network, decoding the data if necessary and saving the data to a file.
-*/
- at interface WebDownload : NSObject
-{
- at private
-    WebDownloadPrivate *_private;
-}
-
-/*!
-    @method initWithRequest:
-    @abstract Initializes a WebDownload object.
-    @param request The request to download. Must not be nil.
-*/
-- initWithRequest:(WebRequest *)request;
-
-/*!
-    @method loadWithDelegate:
-    @abstract Starts the download.
-    @param delegate The delegate of the download. Must not be nil.
+    @protocol WebDownloadDecisionListener
+    @discussion An object that conforms to the WebDownloadDecisionListener protocol is passed
+    with the download:decidePathWithListener:suggestedFilename: method of the WebDownloadDelegate protocol.
+    There is no need to directly create an object that conforms to this protocol.
 */
-- (void)loadWithDelegate:(id)delegate;
-
+ at protocol WebDownloadDecisionListener <NSObject>
 /*!
-    @method cancel
-    @abstract Cancels the download and deletes the downloaded file.
+    @method setPath:
+    @abstract This method should be called when the path of the downloaded file has been decided.
+    @param path The path of the downloaded file.
+    @discussion If necessary, to avoid overwriting files, "-n" (where "n" is a number) will be appended to the
+    filename before the extension. Because of this, use the path passed with download:didCreateFileAtPath:
+    when referring to the path of the downloaded file, not the path set with this method.
 */
-- (void)cancel;
+-(void)setPath:(NSString *)path;
 
 @end

-- 
WebKit Debian packaging