changeset 39917:eb6a85173992

Doc fixes.
author Miles Bader <miles@gnu.org>
date Sun, 14 Oct 2001 15:16:57 +0000
parents 5827976776b9
children fa0407ac162f
files lisp/button.el
diffstat 1 files changed, 22 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/button.el	Sun Oct 14 14:34:44 2001 +0000
+++ b/lisp/button.el	Sun Oct 14 15:16:57 2001 +0000
@@ -113,12 +113,12 @@
 The remaining arguments form a sequence of PROPERTY VALUE pairs,
 specifying properties to use as defaults for buttons with this type
 \(a button's type may be set by giving it a `type' property when
-creating the button).
+creating the button, using the :type keyword argument).
 
-The property `supertype' may be used to specify a button-type from which
-NAME inherits its default property values \(however, the inheritance
-happens only when NAME is defined; subsequent changes to a supertype are
-not reflected in its subtypes)."
+In addition, the keyword argument :supertype may be used to specify a
+button-type from which NAME inherits its default property values
+\(however, the inheritance happens only when NAME is defined; subsequent
+changes to a supertype are not reflected in its subtypes)."
   (let* ((catsym (make-symbol (concat (symbol-name name) "-button")))
 	 (supertype
 	  (or (plist-get properties 'supertype)
@@ -220,6 +220,7 @@
   (buffer-substring-no-properties (button-start button) (button-end button)))
 
 (defsubst button-type (button)
+  "Return BUTTON's button-type."
   (button-get button 'type))
 
 (defun button-has-type-p (button type)
@@ -233,9 +234,10 @@
 (defun make-button (beg end &rest properties)
   "Make a button from BEG to END in the current buffer.
 The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button.  In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
 
 Also see `make-text-button', `insert-button'."
   (let ((overlay (make-overlay beg end nil t nil)))
@@ -254,9 +256,10 @@
 (defun insert-button (label &rest properties)
   "Insert a button with the label LABEL.
 The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button.  In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
 
 Also see `insert-text-button', `make-button'."
   (apply #'make-button
@@ -271,9 +274,10 @@
 (defun make-text-button (beg end &rest properties)
   "Make a button from BEG to END in the current buffer.
 The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button.  In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
 
 This function is like `make-button', except that the button is actually
 part of the text instead of being a property of the buffer.  Creating
@@ -306,9 +310,10 @@
 (defun insert-text-button (label &rest properties)
   "Insert a button with the label LABEL.
 The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button.  In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
 
 This function is like `insert-button', except that the button is
 actually part of the text instead of being a property of the buffer.