Add headerdocs for WKWebsiteDataRecord and WKWebsiteDataStore
authorandersca@apple.com <andersca@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 24 Apr 2015 17:26:08 +0000 (17:26 +0000)
committerandersca@apple.com <andersca@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 24 Apr 2015 17:26:08 +0000 (17:26 +0000)
https://bugs.webkit.org/show_bug.cgi?id=144138

Reviewed by Darin Adler.

* UIProcess/API/Cocoa/WKWebsiteDataRecord.h:
* UIProcess/API/Cocoa/WKWebsiteDataStore.h:
* UIProcess/API/Cocoa/WKWebsiteDataStore.mm:
(-[WKWebsiteDataStore fetchDataRecordsOfTypes:completionHandler:]):
(-[WKWebsiteDataStore removeDataOfTypes:modifiedSince:completionHandler:]):
(-[WKWebsiteDataStore removeDataOfTypes:forDataRecords:completionHandler:]):

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@183267 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit2/ChangeLog
Source/WebKit2/UIProcess/API/Cocoa/WKWebsiteDataRecord.h
Source/WebKit2/UIProcess/API/Cocoa/WKWebsiteDataStore.h
Source/WebKit2/UIProcess/API/Cocoa/WKWebsiteDataStore.mm

index faec2d41a89b007df55c0016eb6e52e844936bb7..153aa4f2298dc8b3818eaee0aa1006b6a6f222e4 100644 (file)
@@ -1,3 +1,17 @@
+2015-04-23  Anders Carlsson  <andersca@apple.com>
+
+        Add headerdocs for WKWebsiteDataRecord and WKWebsiteDataStore
+        https://bugs.webkit.org/show_bug.cgi?id=144138
+
+        Reviewed by Darin Adler.
+
+        * UIProcess/API/Cocoa/WKWebsiteDataRecord.h:
+        * UIProcess/API/Cocoa/WKWebsiteDataStore.h:
+        * UIProcess/API/Cocoa/WKWebsiteDataStore.mm:
+        (-[WKWebsiteDataStore fetchDataRecordsOfTypes:completionHandler:]):
+        (-[WKWebsiteDataStore removeDataOfTypes:modifiedSince:completionHandler:]):
+        (-[WKWebsiteDataStore removeDataOfTypes:forDataRecords:completionHandler:]):
+
 2015-04-24  Doug Russell  <d_russell@apple.com>
 
         AX: richer text change notifications (142719)
index c0ffd7ac241d7a798d289d56e52ae1499ed1d2a7..32998f18c9f6d4b94b17fc3b10b8e6441e7c9fdc 100644 (file)
 
 WK_ASSUME_NONNULL_BEGIN
 
+/*! @constant WKWebsiteDataTypeDiskCache On-disk caches. */
 WK_EXTERN NSString * const WKWebsiteDataTypeDiskCache WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
+
+/*! @constant WKWebsiteDataTypeMemoryCache In-memory caches. */
 WK_EXTERN NSString * const WKWebsiteDataTypeMemoryCache WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
+
+/*! @constant WKWebsiteDataTypeOfflineWebApplicationCache HTML offline web application caches. */
 WK_EXTERN NSString * const WKWebsiteDataTypeOfflineWebApplicationCache WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
 
+/*! @constant WKWebsiteDataTypeCookies Cookies. */
 WK_EXTERN NSString * const WKWebsiteDataTypeCookies WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
+
+/*! @constant WKWebsiteDataTypeLocalStorage HTML local storage. */
 WK_EXTERN NSString * const WKWebsiteDataTypeLocalStorage WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
+
+/*! @constant WKWebsiteDataTypeWebSQLDatabases WebSQL databases. */
 WK_EXTERN NSString * const WKWebsiteDataTypeWebSQLDatabases WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
+
+/*! @constant WKWebsiteDataTypeIndexedDBDatabases IndexedDB databases. */
 WK_EXTERN NSString * const WKWebsiteDataTypeIndexedDBDatabases WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
 
+/*! A WKWebsiteDataRecord represents website data, grouped by domain name using the public suffix list. */
 WK_CLASS_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA)
 @interface WKWebsiteDataRecord : NSObject
 
+/*! @abstract The display name for the data record. This is usually the domain name. */
 @property (nonatomic, readonly, copy) NSString *displayName;
 
+/*! @abstract The various types of website data that exist for this data record. */
 @property (nonatomic, readonly, copy) WK_SET(NSString *) *dataTypes;
 
 @end
index bd275d6cefd041a73d0c508dbd59d90b6bdb4af3..e48a70ea9f97b600fb56987f43f92d1ef0113add 100644 (file)
 
 WK_ASSUME_NONNULL_BEGIN
 
+/*! A WKWebsiteDataStore represents various types of data that a website might
+ make use of. This includes cookies, disk and memory caches, and persistent data such as
+ WebSQL and IndexedDB databases and local storage.
+ */
 WK_CLASS_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA)
 @interface WKWebsiteDataStore : NSObject
 
-// Returns the shared default data store.
+/* @abstract Returns the default data store. */
 + (WKWebsiteDataStore *)defaultDataStore;
 
-// Returns a new non-persistent data store.
+/** @abstract Returns a new non-persistent data store.
+ @discussion If a WKWebView is associated with a non-persistent data store, no data will
+ be written to the file system. This is useful for implementing "private browsing" in a web view.
+*/
 + (WKWebsiteDataStore *)nonPersistentDataStore;
 
 - (instancetype)init WK_UNAVAILABLE;
 
+/*! @abstract Whether the data store is non-persistent or not. */
 @property (readonly, getter=isNonPersistent) BOOL nonPersistent;
 
+/*! @abstract Returns a set of all available website data types. */
 + (WK_SET(NSString *) *)allWebsiteDataTypes;
 
-- (void)fetchDataRecordsOfTypes:(WK_SET(NSString *) *)websiteDataTypes completionHandler:(void (^)(WK_ARRAY(WKWebsiteDataRecord *) *))completionHandler;
-- (void)removeDataOfTypes:(WK_SET(NSString *) *)websiteDataTypes forDataRecords:(WK_ARRAY(WKWebsiteDataRecord *) *)dataRecords completionHandler:(void (^)(void))completionHandler;
+/*! @abstract Fetches data records containing the given website data types.
+  @param dataTypes The website data types to fetch records for.
+  @param completionHandler A block to invoke when the data records have been fetched.
+*/
+- (void)fetchDataRecordsOfTypes:(WK_SET(NSString *) *)dataTypes completionHandler:(void (^)(WK_ARRAY(WKWebsiteDataRecord *) *))completionHandler;
+
+/*! @abstract Removes website data of the given types for the given data records.
+ @param dataTypes The website data types that should be removed.
+ @param dataRecords The website data records to delete website data for.
+ @param completionHandler A block to invoke when the website data for the records has been removed.
+*/
+- (void)removeDataOfTypes:(WK_SET(NSString *) *)dataTypes forDataRecords:(WK_ARRAY(WKWebsiteDataRecord *) *)dataRecords completionHandler:(void (^)(void))completionHandler;
+
+/*! @abstract Removes all website data of the given types that has been modified since the given date.
+ @param dataTypes The website data types that should be removed.
+ @param date A date. All website data modified after this date will be removed.
+ @param completionHandler A block to invoke when the website data has been removed.
+*/
 - (void)removeDataOfTypes:(WK_SET(NSString *) *)websiteDataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler;
 
 @end
index fed92095985d1eacf5300a03a4e367303cd8b5a2..4b8e236ce2cb5c4fea9608372696a2446cc76ddb 100644 (file)
@@ -74,11 +74,11 @@ static std::chrono::system_clock::time_point toSystemClockTime(NSDate *date)
     return system_clock::time_point(duration_cast<system_clock::duration>(duration<double>(date.timeIntervalSince1970)));
 }
 
-- (void)fetchDataRecordsOfTypes:(NSSet *)websiteDataTypes completionHandler:(void (^)(NSArray *))completionHandler
+- (void)fetchDataRecordsOfTypes:(NSSet *)dataTypes completionHandler:(void (^)(NSArray *))completionHandler
 {
     auto completionHandlerCopy = Block_copy(completionHandler);
 
-    _websiteDataStore->websiteDataStore().fetchData(WebKit::toWebsiteDataTypes(websiteDataTypes), [completionHandlerCopy](Vector<WebKit::WebsiteDataRecord> websiteDataRecords) {
+    _websiteDataStore->websiteDataStore().fetchData(WebKit::toWebsiteDataTypes(dataTypes), [completionHandlerCopy](Vector<WebKit::WebsiteDataRecord> websiteDataRecords) {
         Vector<RefPtr<API::Object>> elements;
         elements.reserveInitialCapacity(websiteDataRecords.size());
 
@@ -91,10 +91,10 @@ static std::chrono::system_clock::time_point toSystemClockTime(NSDate *date)
     });
 }
 
-- (void)removeDataOfTypes:(NSSet *)websiteDataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler
+- (void)removeDataOfTypes:(NSSet *)dataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler
 {
     auto completionHandlerCopy = Block_copy(completionHandler);
-    _websiteDataStore->websiteDataStore().removeData(WebKit::toWebsiteDataTypes(websiteDataTypes), toSystemClockTime(date ? date : [NSDate distantPast]), [completionHandlerCopy] {
+    _websiteDataStore->websiteDataStore().removeData(WebKit::toWebsiteDataTypes(dataTypes), toSystemClockTime(date ? date : [NSDate distantPast]), [completionHandlerCopy] {
         completionHandlerCopy();
         Block_release(completionHandlerCopy);
     });
@@ -110,11 +110,11 @@ static Vector<WebKit::WebsiteDataRecord> toWebsiteDataRecords(NSArray *dataRecor
     return result;
 }
 
-- (void)removeDataOfTypes:(NSSet *)websiteDataTypes forDataRecords:(NSArray *)dataRecords completionHandler:(void (^)(void))completionHandler
+- (void)removeDataOfTypes:(NSSet *)dataTypes forDataRecords:(NSArray *)dataRecords completionHandler:(void (^)(void))completionHandler
 {
     auto completionHandlerCopy = Block_copy(completionHandler);
 
-    _websiteDataStore->websiteDataStore().removeData(WebKit::toWebsiteDataTypes(websiteDataTypes), toWebsiteDataRecords(dataRecords), [completionHandlerCopy] {
+    _websiteDataStore->websiteDataStore().removeData(WebKit::toWebsiteDataTypes(dataTypes), toWebsiteDataRecords(dataRecords), [completionHandlerCopy] {
         completionHandlerCopy();
         Block_release(completionHandlerCopy);
     });