summaryrefslogtreecommitdiff
path: root/lisp/button.el
diff options
context:
space:
mode:
authorStefan Kangas <stefan@marxist.se>2021-09-22 20:26:40 +0200
committerStefan Kangas <stefan@marxist.se>2021-09-22 20:26:40 +0200
commitaebba085cba13ad1439462923ffa0520456f1aad (patch)
tree46a8edec2ec2d81da8c4031a79fc5ee08c016933 /lisp/button.el
parent7f06fe894cabf8f33e10386d6adb5d2ce9481a25 (diff)
downloademacs-aebba085cba13ad1439462923ffa0520456f1aad.tar.gz
; More minor stylistic fixes found by checkdoc
Diffstat (limited to 'lisp/button.el')
-rw-r--r--lisp/button.el45
1 files changed, 23 insertions, 22 deletions
diff --git a/lisp/button.el b/lisp/button.el
index 74dfb5d5419..aedd07b762d 100644
--- a/lisp/button.el
+++ b/lisp/button.el
@@ -113,21 +113,22 @@ Mode-specific keymaps may want to use this as their parent keymap.")
;; [this is an internal function]
(defsubst button-category-symbol (type)
- "Return the symbol used by button-type TYPE to store properties.
+ "Return the symbol used by `button-type' TYPE to store properties.
Buttons inherit them by setting their `category' property to that symbol."
(or (get type 'button-category-symbol)
(error "Unknown button type `%s'" type)))
(defun define-button-type (name &rest properties)
"Define a `button type' called NAME (a symbol).
-The remaining arguments form a plist 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, using the :type keyword argument).
+The remaining PROPERTIES arguments form a plist 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, using the :type keyword
+argument).
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
+`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")))
(super-catsym
@@ -156,15 +157,15 @@ changes to a supertype are not reflected in its subtypes)."
name))
(defun button-type-put (type prop val)
- "Set the button-type TYPE's PROP property to VAL."
+ "Set the `button-type' TYPE's PROP property to VAL."
(put (button-category-symbol type) prop val))
(defun button-type-get (type prop)
- "Get the property of button-type TYPE named PROP."
+ "Get the property of `button-type' TYPE named PROP."
(get (button-category-symbol type) prop))
(defun button-type-subtype-p (type supertype)
- "Return non-nil if button-type TYPE is a subtype of SUPERTYPE."
+ "Return non-nil if `button-type' TYPE is a subtype of SUPERTYPE."
(or (eq type supertype)
(and type
(button-type-subtype-p (button-type-get type 'supertype)
@@ -271,11 +272,11 @@ This function only works when BUTTON is in the current buffer."
(button-end button))))
(defsubst button-type (button)
- "Return BUTTON's button-type."
+ "Return BUTTON's `button-type'."
(button-get button 'type))
(defun button-has-type-p (button type)
- "Return non-nil if BUTTON has button-type TYPE, or one of its subtypes."
+ "Return non-nil if BUTTON has `button-type' TYPE, or one of its subtypes."
(button-type-subtype-p (button-get button 'type) type))
(defun button--area-button-p (b)
@@ -290,10 +291,10 @@ Such area buttons are used for buttons in the mode-line and header-line."
(defun make-button (beg end &rest properties)
"Make a button from BEG to END in the current buffer.
-The remaining arguments form a plist of PROPERTY VALUE pairs,
-specifying properties to add to the button.
+The remaining PROPERTIES arguments form a plist of PROPERTY VALUE
+pairs, 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
+`button-type' from which to inherit other properties; see
`define-button-type'.
Also see `make-text-button', `insert-button'."
@@ -314,7 +315,7 @@ Also see `make-text-button', `insert-button'."
The remaining arguments form a plist of PROPERTY VALUE pairs,
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
+`button-type' from which to inherit other properties; see
`define-button-type'.
Also see `insert-text-button', `make-button'."
@@ -328,10 +329,10 @@ Also see `insert-text-button', `make-button'."
(defun make-text-button (beg end &rest properties)
"Make a button from BEG to END in the current buffer.
-The remaining arguments form a plist of PROPERTY VALUE pairs,
-specifying properties to add to the button.
+The remaining PROPERTIES arguments form a plist of PROPERTY VALUE
+pairs, 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
+`button-type' from which to inherit other properties; see
`define-button-type'.
This function is like `make-button', except that the button is actually
@@ -382,10 +383,10 @@ Also see `insert-text-button'."
(defun insert-text-button (label &rest properties)
"Insert a button with the label LABEL.
-The remaining arguments form a plist of PROPERTY VALUE pairs,
-specifying properties to add to the button.
+The remaining PROPERTIES arguments form a plist of PROPERTY VALUE
+pairs, 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
+`button-type' from which to inherit other properties; see
`define-button-type'.
This function is like `insert-button', except that the button is