[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677
rjw
rjw at 268f45cc-cd09-0410-ab3c-d52691b4dbfc
Sat Sep 26 06:44:26 UTC 2009
The following commit has been merged in the debian/unstable branch:
commit 039ed9ee4263fb074e30214c17574a4f58035328
Author: rjw <rjw at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Wed Sep 25 01:42:32 2002 +0000
More documentation tweaks.
* History.subproj/WebHistory.h:
* History.subproj/WebHistoryItem.h:
* WebView.subproj/WebContextMenuDelegate.h:
* WebView.subproj/WebControllerPolicyDelegate.h:
* WebView.subproj/WebLocationChangeDelegate.h:
* WebView.subproj/WebResourceProgressDelegate.h:
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@2157 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index bfc8350..9d29fb9 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,14 @@
+2002-09-24 Richard Williamson <rjw at apple.com>
+
+ More documentation tweaks.
+
+ * History.subproj/WebHistory.h:
+ * History.subproj/WebHistoryItem.h:
+ * WebView.subproj/WebContextMenuDelegate.h:
+ * WebView.subproj/WebControllerPolicyDelegate.h:
+ * WebView.subproj/WebLocationChangeDelegate.h:
+ * WebView.subproj/WebResourceProgressDelegate.h:
+
2002-09-24 Darin Adler <darin at apple.com>
- fixed 3059513 -- REGRESSION: Scrolling to fragment doesn't work
@@ -32,7 +43,7 @@
2002-09-24 Richard Williamson <rjw at apple.com>
- Added FIXME not about unresolved issue with CFStringEncoding/NSStringEncoding.
+ Added FIXME note about unresolved issue with CFStringEncoding/NSStringEncoding.
* WebView.subproj/WebController.h:
diff --git a/WebKit/ChangeLog-2002-12-03 b/WebKit/ChangeLog-2002-12-03
index bfc8350..9d29fb9 100644
--- a/WebKit/ChangeLog-2002-12-03
+++ b/WebKit/ChangeLog-2002-12-03
@@ -1,3 +1,14 @@
+2002-09-24 Richard Williamson <rjw at apple.com>
+
+ More documentation tweaks.
+
+ * History.subproj/WebHistory.h:
+ * History.subproj/WebHistoryItem.h:
+ * WebView.subproj/WebContextMenuDelegate.h:
+ * WebView.subproj/WebControllerPolicyDelegate.h:
+ * WebView.subproj/WebLocationChangeDelegate.h:
+ * WebView.subproj/WebResourceProgressDelegate.h:
+
2002-09-24 Darin Adler <darin at apple.com>
- fixed 3059513 -- REGRESSION: Scrolling to fragment doesn't work
@@ -32,7 +43,7 @@
2002-09-24 Richard Williamson <rjw at apple.com>
- Added FIXME not about unresolved issue with CFStringEncoding/NSStringEncoding.
+ Added FIXME note about unresolved issue with CFStringEncoding/NSStringEncoding.
* WebView.subproj/WebController.h:
diff --git a/WebKit/History.subproj/WebHistory.h b/WebKit/History.subproj/WebHistory.h
index 7ddc42e..2e5104b 100644
--- a/WebKit/History.subproj/WebHistory.h
+++ b/WebKit/History.subproj/WebHistory.h
@@ -1,13 +1,14 @@
-//
-// WebHistory.h
-// WebKit
-//
-// Created by John Sullivan on Mon Feb 18 2002.
-// Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
-//
-
+/*
+ WebHistory.h
+ Copyright 2001, 2002, Apple Computer, Inc.
+
+ Public header file.
+
+ FIXME Strip down this API.
+*/
#import <Foundation/Foundation.h>
+// FIXME Cannot inherit from WebCoreHistory
#import <WebCore/WebCoreHistory.h>
@class WebHistoryItem;
@@ -16,52 +17,123 @@
// notification sent when history is modified
extern NSString *WebHistoryEntriesChangedNotification;
+/*!
+ @class WebHistory
+ @discussion WebHistory is used to track pages that have been loaded
+ by WebKit.
+*/
@interface WebHistory : WebCoreHistory {
@private
WebHistoryPrivate *_historyPrivate;
}
+/*!
+ @method webHistoryWithFile:
+ @param file The file to use to initialize the WebHistory.
+ @result Returns a WebHistory initialized with the contents of file.
+*/
+ (WebHistory *)webHistoryWithFile: (NSString *)file;
-- (id)initWithFile: (NSString *)file;
-// modifying contents
+/*!
+ @method initWithFile:
+ @abstract The designated initializer for WebHistory.
+ @result Returns an initialized WebHistory.
+*/
+- initWithFile: (NSString *)file;
+
+/*!
+ @method addEntry:
+ @param entry
+*/
- (void)addEntry: (WebHistoryItem *)entry;
+
+/*!
+ @method addEntries:
+ @param newEntries
+*/
- (void)addEntries:(NSArray *)newEntries;
+
+/*!
+ @method removeEntry:
+ @param entry
+*/
- (void)removeEntry: (WebHistoryItem *)entry;
+
+/*!
+ @method removeEntries:
+ @param entries
+*/
- (void)removeEntries: (NSArray *)entries;
+
+/*!
+ @method removeAllEntries
+*/
- (void)removeAllEntries;
-// Update an entry in place. Any nil "new" parameters aren't updated.
+/*!
+ @method updateURL:title:displayTitle:forURL:
+ @discussion Update an entry in place. Any nil "new" parameters aren't updated.
+ @param newURLString
+ @param newTitle
+ @param newDisplayTitle
+ @param oldURLString
+*/
- (void)updateURL:(NSString *)newURLString
title:(NSString *)newTitle
displayTitle:(NSString *)newDisplayTitle
forURL:(NSString *)oldURLString;
-// retrieving contents for date-based presentation
-
-// get an array of NSCalendarDate, each one representing a unique day that contains one
-// or more history entries, ordered from most recent to oldest.
+/*!
+ @method orderedLastVisitedDays
+ @discussion Get an array of NSCalendarDate, each one representing a unique day that contains one
+ or more history entries, ordered from most recent to oldest.
+ @result Returns an array of WebHistoryItems
+*/
- (NSArray *)orderedLastVisitedDays;
-// get an array of WebHistoryItem that were last visited on the day represented by the
-// specified NSCalendarDate, ordered from most recent to oldest.
+/*!
+ @method orderedEntriesLastVisitedOnDay:
+ @discussion Get an array of WebHistoryItem that were last visited on the day represented by the
+ specified NSCalendarDate, ordered from most recent to oldest.
+ @param calendarDate
+ @result Returns an array of WebHistoryItems
+*/
- (NSArray *)orderedEntriesLastVisitedOnDay: (NSCalendarDate *)calendarDate;
-// testing contents for visited-link mechanism
+/*!
+ @method containsURL:
+ @param URL
+ @discussion testing contents for visited-link mechanism
+*/
- (BOOL)containsURL: (NSURL *)URL;
-// retreiving information for a specific URL
+/*!
+ @method entryForURL:
+ @discussion Get an item for a specific URL
+ @param URL
+ @result Returns an item matching the URL
+*/
- (WebHistoryItem *)entryForURL:(NSURL *)URL;
-// storing contents on disk
-
-// The file path used for storing history, specified in -[WebHistory initWithFile:] or +[WebHistory webHistoryWithFile:]
+/*!
+ @method file
+ @discussion The file path used for storing history, specified in -[WebHistory initWithFile:] or +[WebHistory webHistoryWithFile:]
+ @result Returns the file path used to store the history.
+*/
- (NSString *)file;
-// Load history from file. This happens automatically at init time, and need not normally be called.
+/*!
+ @method loadHistory
+ @discussion Load history from file. This happens automatically at init time, and need not normally be called.
+ @result Returns YES if successful, not otherwise.
+*/
- (BOOL)loadHistory;
-// Save history to file. It is the client's responsibility to call this at appropriate times.
+/*!
+ @method saveHistory
+ @discussion Save history to file. It is the client's responsibility to call this at appropriate times.
+ @result Returns YES if successful, not otherwise.
+*/
- (BOOL)saveHistory;
@end
diff --git a/WebKit/History.subproj/WebHistoryItem.h b/WebKit/History.subproj/WebHistoryItem.h
index 88bfd5f..7992dc1 100644
--- a/WebKit/History.subproj/WebHistoryItem.h
+++ b/WebKit/History.subproj/WebHistoryItem.h
@@ -1,10 +1,15 @@
/*
WebHistoryItem.h
Copyright 2001, 2002, Apple, Inc. All rights reserved.
+
+ FIXME Strip down this API.
*/
#import <Cocoa/Cocoa.h>
+/*!
+ @class WebHistoryItem
+*/
@interface WebHistoryItem : NSObject
{
NSURL *_URL;
diff --git a/WebKit/WebView.subproj/WebContextMenuDelegate.h b/WebKit/WebView.subproj/WebContextMenuDelegate.h
index e222fd4..1c06781 100644
--- a/WebKit/WebView.subproj/WebContextMenuDelegate.h
+++ b/WebKit/WebView.subproj/WebContextMenuDelegate.h
@@ -6,8 +6,8 @@
*/
/*!
- @protocol WebContextMenuHandler
- @discussion WebContextMenuHandler determine what context menu items are visible over
+ @protocol WebContextMenuDelegate
+ @discussion WebContextMenuDelegate determine what context menu items are visible over
a clicked element.
*/
diff --git a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
index d5db289..6e4a3ef 100644
--- a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
@@ -184,8 +184,8 @@ typedef enum {
/*!
- @protocol WebControllerPolicyHandler
- @discussion While loading a URL, WebKit asks the WebControllerPolicyHandler for
+ @protocol WebControllerPolicyDelegate
+ @discussion While loading a URL, WebKit asks the WebControllerPolicyDelegate for
policies that determine the action of what to do with the URL or the data that
the URL represents. Typically, the policy handler methods are called in this order:
diff --git a/WebKit/WebView.subproj/WebFrameLoadDelegate.h b/WebKit/WebView.subproj/WebFrameLoadDelegate.h
index c6532a4..08ba0bd 100644
--- a/WebKit/WebView.subproj/WebFrameLoadDelegate.h
+++ b/WebKit/WebView.subproj/WebFrameLoadDelegate.h
@@ -53,7 +53,7 @@
@abstract Notify that the page title has been determined or has changed
@param title The new page title
@param dataSource The data source for which the title changed
- @disucssion The title may update during loading; clients should be prepared for this.
+ @discussion The title may update during loading; clients should be prepared for this.
*/
- (void)receivedPageTitle:(NSString *)title forDataSource:(WebDataSource *)dataSource;
diff --git a/WebKit/WebView.subproj/WebLocationChangeDelegate.h b/WebKit/WebView.subproj/WebLocationChangeDelegate.h
index c6532a4..08ba0bd 100644
--- a/WebKit/WebView.subproj/WebLocationChangeDelegate.h
+++ b/WebKit/WebView.subproj/WebLocationChangeDelegate.h
@@ -53,7 +53,7 @@
@abstract Notify that the page title has been determined or has changed
@param title The new page title
@param dataSource The data source for which the title changed
- @disucssion The title may update during loading; clients should be prepared for this.
+ @discussion The title may update during loading; clients should be prepared for this.
*/
- (void)receivedPageTitle:(NSString *)title forDataSource:(WebDataSource *)dataSource;
diff --git a/WebKit/WebView.subproj/WebPolicyDelegate.h b/WebKit/WebView.subproj/WebPolicyDelegate.h
index d5db289..6e4a3ef 100644
--- a/WebKit/WebView.subproj/WebPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebPolicyDelegate.h
@@ -184,8 +184,8 @@ typedef enum {
/*!
- @protocol WebControllerPolicyHandler
- @discussion While loading a URL, WebKit asks the WebControllerPolicyHandler for
+ @protocol WebControllerPolicyDelegate
+ @discussion While loading a URL, WebKit asks the WebControllerPolicyDelegate for
policies that determine the action of what to do with the URL or the data that
the URL represents. Typically, the policy handler methods are called in this order:
diff --git a/WebKit/WebView.subproj/WebResourceLoadDelegate.h b/WebKit/WebView.subproj/WebResourceLoadDelegate.h
index 34592e0..abbc912 100644
--- a/WebKit/WebView.subproj/WebResourceLoadDelegate.h
+++ b/WebKit/WebView.subproj/WebResourceLoadDelegate.h
@@ -8,7 +8,7 @@
@class WebResourceHandle;
/*!
- @protocol WebResourceProgressHandler
+ @protocol WebResourceProgressDelegate
@discussion Implementors of this protocol will receive messages indicating
data has been received for resources loaded by a data source.
*/
diff --git a/WebKit/WebView.subproj/WebResourceProgressDelegate.h b/WebKit/WebView.subproj/WebResourceProgressDelegate.h
index 34592e0..abbc912 100644
--- a/WebKit/WebView.subproj/WebResourceProgressDelegate.h
+++ b/WebKit/WebView.subproj/WebResourceProgressDelegate.h
@@ -8,7 +8,7 @@
@class WebResourceHandle;
/*!
- @protocol WebResourceProgressHandler
+ @protocol WebResourceProgressDelegate
@discussion Implementors of this protocol will receive messages indicating
data has been received for resources loaded by a data source.
*/
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list