[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677
cblu
cblu at 268f45cc-cd09-0410-ab3c-d52691b4dbfc
Sat Sep 26 06:54:26 UTC 2009
The following commit has been merged in the debian/unstable branch:
commit 2f2b6e9c2f792de154fbf251dc14c177d34a9cef
Author: cblu <cblu at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Fri Oct 25 17:11:40 2002 +0000
Cleaned up the plug-in API headers so they can be sent to other groups.
* Plugins.subproj/WebPlugin.h:
* Plugins.subproj/WebPluginContainer.h:
* Plugins.subproj/WebPluginViewFactory.h:
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@2466 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index 05ad7b4..0aa8cde 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,11 @@
+2002-10-25 Chris Blumenberg <cblu at apple.com>
+
+ Cleaned up the plug-in API headers so they can be sent to other groups.
+
+ * Plugins.subproj/WebPlugin.h:
+ * Plugins.subproj/WebPluginContainer.h:
+ * Plugins.subproj/WebPluginViewFactory.h:
+
2002-10-24 Richard Williamson <rjw at apple.com>
Fixed many font substitution related bugs, at least including:
diff --git a/WebKit/ChangeLog-2002-12-03 b/WebKit/ChangeLog-2002-12-03
index 05ad7b4..0aa8cde 100644
--- a/WebKit/ChangeLog-2002-12-03
+++ b/WebKit/ChangeLog-2002-12-03
@@ -1,3 +1,11 @@
+2002-10-25 Chris Blumenberg <cblu at apple.com>
+
+ Cleaned up the plug-in API headers so they can be sent to other groups.
+
+ * Plugins.subproj/WebPlugin.h:
+ * Plugins.subproj/WebPluginContainer.h:
+ * Plugins.subproj/WebPluginViewFactory.h:
+
2002-10-24 Richard Williamson <rjw at apple.com>
Fixed many font substitution related bugs, at least including:
diff --git a/WebKit/Plugins.subproj/WebPlugin.h b/WebKit/Plugins.subproj/WebPlugin.h
index 3fd7655..35004c1 100644
--- a/WebKit/Plugins.subproj/WebPlugin.h
+++ b/WebKit/Plugins.subproj/WebPlugin.h
@@ -1,65 +1,57 @@
-//
-// WebPlugin.h
-//
-// Created by Mike Hay <mhay at apple.com> on Tue Oct 15 2002.
-// Copyright (c) 2002 Apple Computer. All rights reserved.
-//
-
-//
-// About WebPlugin
-//
-// This protocol enables the application that loads the web plugin
-// to control the plugin (e.g. init, start, stop, destroy).
-//
+/*
+ WebPlugin.h
+ Copyright 2002, Apple, Inc. All rights reserved.
+*/
#import <Cocoa/Cocoa.h>
+/*!
+ @protocol WebPlugin
+ @discussion Protocol that enables the application that loads the web plugin
+ to control it (e.g. init, start, stop, destroy). This protocol is typically
+ implemented by an NSView subclass.
+*/
@protocol WebPlugin <NSObject>
-//
-// pluginInitialize request that the plugin perform one-time initialization.
-//
-// must be only called once per instance of the plugin object.
-//
-// must be called before any other methods in this protocol.
-//
+/*!
+ @method pluginInitialize
+ @abstract Tell the plugin to perform one-time initialization.
+ @discussion This method must be only called once per instance of the plugin
+ object and must be called before any other methods in this protocol.
+*/
- (void)pluginInitialize;
-//
-// pluginStart request that the plugin start normal operation.
-// (e.g. drawing, playing sounds, animation)
-//
-// application must call pluginStart before calling pluginStop.
-//
-// application may call pluginStart more than once, provided
-// that the application has already called pluginInitialize
-// and that each call to pluginStart is followed by a call
-// to pluginStop.
-//
+/*!
+ @method pluginStart
+ @abstract Tell the plugin to start normal operation.
+ @discussion The plug-in usually begins drawing, playing sounds and/or
+ animation in this method. This method must be called before calling pluginStop.
+ This method may called more than once, provided that the application has
+ already called pluginInitialize and that each call to pluginStart is followed
+ by a call to pluginStop.
+*/
- (void)pluginStart;
-//
-// pluginStop request that the plugin stop normal operation.
-// (e.g. drawing, playing sounds, animation)
-//
-// application must call pluginStart before calling pluginStop.
-//
-// application may call pluginStop more than once, provided
-// that the application has already called pluginInitialize
-// and that each call to pluginStop is preceded by a call
-// to pluginStart.
-//
+/*!
+ @method pluginStop
+ @abstract Tell the plugin stop normal operation.
+ @discussion pluginStart must be called before this method. This method may be
+ called more than once, provided that the application has already called
+ pluginInitialize and that each call to pluginStop is preceded by a call to
+ pluginStart.
+*/
- (void)pluginStop;
-//
-// pluginDestroy request that the plugin perform cleanup and prepare to be
-// destroyed. (e.g. release memory and other resources)
-//
-// must be only called once per instance of the plugin object.
-//
-// no other methods in this interface may be called after
-// the application has called pluginDestroy.
+/*!
+ @method pluginDestroy
+ @abstract Tell the plugin perform cleanup and prepare to be dealloced.
+ @discussion The plug-in typically releases memory and other resources in this
+ method. If the plug-in has retained the WebPluginContainer, it must release
+ it in this mehthod. This method must be only called once per instance of the
+ plugin object. No other methods in this interface may be called after the
+ application has called pluginDestroy.
+*/
- (void)pluginDestroy;
@end
\ No newline at end of file
diff --git a/WebKit/Plugins.subproj/WebPluginContainer.h b/WebKit/Plugins.subproj/WebPluginContainer.h
index ea54393..aa4185d 100644
--- a/WebKit/Plugins.subproj/WebPluginContainer.h
+++ b/WebKit/Plugins.subproj/WebPluginContainer.h
@@ -1,32 +1,34 @@
-//
-// WebPluginContainer.h
-//
-// Created by Mike Hay <mhay at apple.com> on Tue Oct 15 2002.
-// Copyright (c) 2002 Apple Computer. All rights reserved.
-//
-
-//
-// About WebPluginContainer
-//
-// This protocol enables an applet to request that its
-// host application perform certain specific operations.
-//
+/*
+ WebPluginContainer.h
+ Copyright 2002, Apple, Inc. All rights reserved.
+*/
#import <Cocoa/Cocoa.h>
+/*!
+ @protocol WebPluginContainer
+ @discussion This protocol enables a plug-in to request that its application
+ perform certain operations.
+*/
@protocol WebPluginContainer <NSObject>
-//
-// showURL:inFrame: plugin requests that the host app show the specified URL in the target frame.
-//
-// target may be nil. if target is nil, the URL should be shown in a new window.
-//
+/*!
+ @method showURL:inFrame:
+ @abstract Tell the application to show a URL in a target frame
+ @param URL The URL to be shown. May not be nil.
+ @param target The target frame. If the frame with the specified target is not
+ found, a new window is opened and the main frame of the new window is named
+ with the specified target.
+*/
- (void)showURL:(NSURL *)URL inFrame:(NSString *)target;
-//
-// showStatus: plugin requests that the host app show the specified status message.
-//
+
+/*!
+ @method showStatus:
+ @abstract Tell the application to show the specified status message.
+ @param message The string to be shown. May not be nil.
+*/
- (void)showStatus:(NSString *)message;
@end
\ No newline at end of file
diff --git a/WebKit/Plugins.subproj/WebPluginViewFactory.h b/WebKit/Plugins.subproj/WebPluginViewFactory.h
index 76070e1..01ff6bb 100644
--- a/WebKit/Plugins.subproj/WebPluginViewFactory.h
+++ b/WebKit/Plugins.subproj/WebPluginViewFactory.h
@@ -1,88 +1,63 @@
-//
-// WebPluginViewFactory.h
-//
-// Created by Mike Hay <mhay at apple.com> on Tue Oct 15 2002.
-// Copyright (c) 2002 Apple Computer. All rights reserved.
-//
-
-//
-// About WebPluginViewFactory
-//
-// This protocol is used to create a Cocoa view that is used as a canvas
-// by a web plugin, to display a Java Applet or QuickTime movie, for example.
-//
-// The view returned will be a descendant of NSView which conforms to
-// the WebPlugin protocol.
-//
-// Because it is a descendant of NSView, a WebPluginView can be placed
-// inside other Cocoa views or windows easily.
-//
-// The application can control the web plugin via the WebPlugin protocol.
-//
+/*
+ WebPluginViewFactory.h
+ Copyright 2002, Apple, Inc. All rights reserved.
+*/
#import <Cocoa/Cocoa.h>
@protocol WebPlugin;
-//
-// Keys Used in the Arguments Dictionary
-//
-
-//
-// WebPluginBaseURL ....... REQUIRED base URL of the document containing the plugin's view.
-// (NSURL *)
-//
+/*!
+ @constant WebPluginBaseURLKey REQUIRED. The base URL of the document containing
+ the plugin's view.
+*/
#define WebPluginBaseURLKey @"WebPluginBaseURL"
-//
-// WebPluginAttributes .... REQUIRED dictionary containing the names and values of all attributes
-// (NSDictionary *) of the HTML element associated with the plugin AND the names
-// and values of all parameters to be passed to the plugin
-// (e.g. PARAM elements within an APPLET element).
-//
-// in the case of a conflict between names, the attributes of an
-// element take precedence over any PARAMs.
-//
-// all of the keys and values in this NSDictionary must be
-// NSStrings.
-//
+/*!
+ @constant WebPluginAttributesKey REQUIRED. The dictionary containing the names
+ and values of all attributes of the HTML element associated with the plugin AND
+ the names and values of all parameters to be passed to the plugin (e.g. PARAM
+ elements within an APPLET element). In the case of a conflict between names,
+ the attributes of an element take precedence over any PARAMs. All of the keys
+ and values in this NSDictionary must be NSStrings.
+*/
#define WebPluginAttributesKey @"WebPluginAttributes"
-//
-// WebPluginContainer ..... OPTIONAL a Cocoa object that conforms to the WebPluginContainer protocol.
-// (id<WebPluginContainer> *) this object is used for callbacks from the plugin to the app.
-//
-// if this argument is nil, no callbacks will occur.
-//
+/*!
+ @constant WebPluginContainer OPTIONAL. An object that conforms to the
+ WebPluginContainer protocol (id<WebPluginContainer> *). This object is used for
+ callbacks from the plugin to the app. if this argument is nil, no callbacks will
+ occur.
+*/
#define WebPluginContainerKey @"WebPluginContainer"
-//
-// WebPluginDefaultView ... OPTIONAL an NSView object that will be used as a visual placeholder
-// (NSView *) until the plugin begins drawing.
-//
-// the view will be removed by the plugin immediately before the
-// plugin begins drawing into the WebPluginView.
-//
-// if this argument is nil, the plugin's default view will be used.
-// (as an application, if you care about the appearance of this
-// space before the plugin begins drawing or if the plugin never
-// begins drawing, provide a view.)
-//
+/*!
+ @constant WebPluginDefaultView OPTIONAL. An NSView object that will be used as a
+ visual placeholder until the plugin begins drawing. The view will be removed by
+ the plugin immediately before the plugin begins drawing into the view.
+ If this argument is nil, the plugin's default view will be used.
+*/
#define WebPluginDefaultViewKey @"WebPluginDefaultView"
-
-
-//
-// WebPluginViewFactory protocol
-//
+/*!
+ @protocol WebPluginViewFactory
+ @discussion Protocol is used to create a Cocoa view that is used as a canvas
+ by a web plugin, to display a Java Applet or QuickTime movie, for example.
+ The view returned will be a descendant of NSView which conforms to the WebPlugin
+ protocol. Because it is a descendant of NSView, a WebPluginView can be placed
+ inside other Cocoa views or windows easily. The application can control the web
+ plugin via the WebPlugin protocol.
+*/
@protocol WebPluginViewFactory <NSObject>
-//
-// pluginViewWithArguments: returns an NSView object that conforms to the WebPlugin protocol
-//
-+ (NSView<WebPlugin> *) pluginViewWithArguments: (NSDictionary *) args;
+/*!
+ @method pluginViewWithArguments:
+ @abstract Returns an NSView object that conforms to the WebPlugin protocol.
+ @param arguments The arguments dictionary with the mentioned keys and objects.
+*/
++ (NSView<WebPlugin> *) pluginViewWithArguments:(NSDictionary *)arguments;
@end
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list