[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 6c0d9046488cd0d6a20ee353a50be30369db747b
Author: cblu <cblu at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date:   Fri Apr 23 21:17:54 2004 +0000

    	Reviewed by John
    
    	Added header doc comments to proposed API's.
    
            * WebView.subproj/WebArchive.h:
            * WebView.subproj/WebFramePrivate.h:
            * WebView.subproj/WebResource.h:
    
    
    git-svn-id: http://svn.webkit.org/repository/webkit/trunk@6470 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index ed9fe2c..d134d4d 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,13 @@
+2004-04-23  Chris Blumenberg  <cblu at apple.com>
+
+	Reviewed by John
+
+	Added header doc comments to proposed API's.
+
+        * WebView.subproj/WebArchive.h:
+        * WebView.subproj/WebFramePrivate.h:
+        * WebView.subproj/WebResource.h:
+
 === Safari-138 ===
 
 2004-04-23  Ken Kocienda  <kocienda at apple.com>
diff --git a/WebKit/WebView.subproj/WebArchive.h b/WebKit/WebView.subproj/WebArchive.h
index 7136fb2..a1c2d15 100644
--- a/WebKit/WebView.subproj/WebArchive.h
+++ b/WebKit/WebView.subproj/WebArchive.h
@@ -10,21 +10,67 @@
 @class WebArchivePrivate;
 @class WebResource;
 
+/*!
+    @const WebArchivePboardType
+    @abstract The pasteboard type constant used when adding or accessing a WebArchive on the pasteboard.
+*/
 extern NSString *WebArchivePboardType;
 
+/*!
+    @class WebArchive
+    @discussion WebArchive represents a main resource as well as all the subresources and subframes associated with the main resource.
+    The main resource can be an entire web page, a portion of a web page, or some other kind of data such as an image.
+    This class can be used for saving standalone web pages, representing portions of a web page on the pasteboard, or any other
+    application where one class is needed to represent rich web content. 
+*/
 @interface WebArchive : NSObject 
 {
     @private
     WebArchivePrivate *_private;
 }
 
+/*!
+    @method initWithMainResource:subresources:subframeArchives:
+    @abstract The initializer for WebArchive.
+    @param mainResource The main resource of the archive.
+    @param subresources The subresources of the archive (can be nil).
+    @param subframeArchives The archives representing the subframes of the archive (can be nil).
+    @result An initialized WebArchive.
+*/
 - (id)initWithMainResource:(WebResource *)mainResource subresources:(NSArray *)subresources subframeArchives:(NSArray *)subframeArchives;
+
+/*!
+    @method initWithData:
+    @abstract The initializer for creating a WebArchive from data.
+    @param data The data representing the archive. This can be obtained using WebArchive's data method.
+    @result An initialized WebArchive.
+*/
 - (id)initWithData:(NSData *)data;
 
+/*!
+    @method mainResource
+    @result The main resource of the archive.
+*/
 - (WebResource *)mainResource;
+
+/*!
+    @method subresources
+    @result The subresource of the archive (can be nil).
+*/
 - (NSArray *)subresources;
+
+/*!
+    @method subframeArchives
+    @result The archives representing the subframes of the archive (can be nil).
+*/
 - (NSArray *)subframeArchives;
 
+/*!
+    @method data
+    @result The data representation of the archive.
+    @discussion The data returned by this method can be used to save a web archive to a file or to place a web archive on the pasteboard
+    using WebArchivePboardType. To create a WebArchive using the returned data, call initWithData:.
+*/
 - (NSData *)data;
 
 @end
diff --git a/WebKit/WebView.subproj/WebFramePrivate.h b/WebKit/WebView.subproj/WebFramePrivate.h
index 98981cf..baab2fa 100644
--- a/WebKit/WebView.subproj/WebFramePrivate.h
+++ b/WebKit/WebView.subproj/WebFramePrivate.h
@@ -123,6 +123,11 @@ extern NSString *WebPageCacheDocumentViewKey;
 @interface WebFrame (WebPrivate)
 
 // API Considerations:
+/*!
+    @method loadArchive:
+    @abstract Causes WebFrame to load a WebArchive.
+    @param The archive to be loaded.
+*/
 - (void)loadArchive:(WebArchive *)archive;
 
 // Other private methods
diff --git a/WebKit/WebView.subproj/WebResource.h b/WebKit/WebView.subproj/WebResource.h
index f4851c4..26798f3 100644
--- a/WebKit/WebView.subproj/WebResource.h
+++ b/WebKit/WebView.subproj/WebResource.h
@@ -10,18 +10,58 @@
 @class WebMainResourcePrivate;
 @class WebResourcePrivate;
 
+
+/*!
+    @class WebResource
+    @discussion A WebResource represents a fully downloaded resource. It includes the data of the resource
+    as well as the metadata associated with the resource.
+*/
 @interface WebResource : NSObject 
 {
 @private
     WebResourcePrivate *_private;
 }
 
+/*!
+    @method initWithData:URL:MIMEType:textEncodingName:frameName
+    @abstract The initializer for WebResource.
+    @param data The data of the resource.
+    @param URL The URL of the resource.
+    @param MIMEType The MIME type of the resource.
+    @param textEncodingName The text encoding name of the resource (can be nil).
+    @param frameName The frame name of the resource if the resource represents the contents of an entire HTML frame (can be nil).
+    @result An initialized WebResource.
+*/
 - (id)initWithData:(NSData *)data URL:(NSURL *)URL MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)textEncodingName frameName:(NSString *)frameName;
 
+/*!
+    @method data
+    @result The data of the resource.
+*/
 - (NSData *)data;
+
+/*!
+    @method URL
+    @result The URL of the resource.
+*/
 - (NSURL *)URL;
+
+/*!
+    @method MIMEType
+    @result The MIME type of the resource.
+*/
 - (NSString *)MIMEType;
+
+/*!
+    @method textEncodingName
+    @result The text encoding name of the resource (can be nil).
+*/
 - (NSString *)textEncodingName;
+
+/*!
+    @method frameName
+    @result The frame name of the resource if the resource represents the contents of an entire HTML frame (can be nil).
+*/
 - (NSString *)frameName;
 
 @end

-- 
WebKit Debian packaging