mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-21 06:55:39 +00:00
Checkdoc fixes in erc/*.el
* lisp/erc/erc-backend.el (erc-server-parameters): * lisp/erc/erc-button.el (erc-button--display-error-with-buttons): * lisp/erc/erc-dcc.el (erc-dcc-member): * lisp/erc/erc-fill.el (erc-fill-wrap-refill-buffer): * lisp/erc/erc-speedbar.el (erc-speedbar--last-ran): * lisp/erc/erc-stamp.el (erc-stamp--current-time): * lisp/erc/erc-track.el (erc-make-mode-line-buffer-name): * lisp/erc/erc.el (erc-interactive-display, erc-modules, erc-cmd-CLEAR) (erc-update-current-channel-member, erc--format-user-modes) (erc-check-text-conversion): Checkdoc fixes.
This commit is contained in:
parent
e392382e2e
commit
c85f67a66d
@ -260,7 +260,7 @@ or
|
|||||||
where PARAMETER is a string and VALUE is a string or nil. For
|
where PARAMETER is a string and VALUE is a string or nil. For
|
||||||
compatibility, a raw parameter of the form \"FOO=\" becomes
|
compatibility, a raw parameter of the form \"FOO=\" becomes
|
||||||
(\"FOO\" . \"\") even though it's equivalent to the preferred
|
(\"FOO\" . \"\") even though it's equivalent to the preferred
|
||||||
canonical form \"FOO\" and its lisp representation (\"FOO\").
|
canonical form \"FOO\" and its Lisp representation (\"FOO\").
|
||||||
|
|
||||||
Some examples of possible parameters sent by servers:
|
Some examples of possible parameters sent by servers:
|
||||||
CHANMODES=b,k,l,imnpst - list of supported channel modes
|
CHANMODES=b,k,l,imnpst - list of supported channel modes
|
||||||
|
@ -815,7 +815,7 @@ and `apropos' for other symbols."
|
|||||||
|
|
||||||
(defun erc-button--display-error-with-buttons
|
(defun erc-button--display-error-with-buttons
|
||||||
(from to fun nick-p &optional data regexp)
|
(from to fun nick-p &optional data regexp)
|
||||||
"Replace command in region with keys and return new bounds"
|
"Replace command in region with keys and return new bounds."
|
||||||
(let* ((o (buffer-substring from to))
|
(let* ((o (buffer-substring from to))
|
||||||
(s (substitute-command-keys o))
|
(s (substitute-command-keys o))
|
||||||
(erc-button-face (and (equal o s) erc-button-face)))
|
(erc-button-face (and (equal o s) erc-button-face)))
|
||||||
|
@ -173,7 +173,7 @@ ARGS is a plist. Return nil on no match.
|
|||||||
|
|
||||||
The property :nick is treated specially, if it contains a `!' character,
|
The property :nick is treated specially, if it contains a `!' character,
|
||||||
it is treated as a nick!user@host string, and compared with the :nick property
|
it is treated as a nick!user@host string, and compared with the :nick property
|
||||||
value of the individual elements using string-equal. Otherwise it is
|
value of the individual elements using `string-equal'. Otherwise it is
|
||||||
compared with `erc-nick-equal-p' which is IRC case-insensitive."
|
compared with `erc-nick-equal-p' which is IRC case-insensitive."
|
||||||
(let ((list erc-dcc-list)
|
(let ((list erc-dcc-list)
|
||||||
result test)
|
result test)
|
||||||
|
@ -799,7 +799,7 @@ necessary after revealing previously hidden text with commands
|
|||||||
like `erc-match-toggle-hidden-fools'."
|
like `erc-match-toggle-hidden-fools'."
|
||||||
(interactive "P")
|
(interactive "P")
|
||||||
(unless erc-fill-wrap-mode
|
(unless erc-fill-wrap-mode
|
||||||
(user-error "Module `fill-wrap' not active in current buffer."))
|
(user-error "Module `fill-wrap' not active in current buffer"))
|
||||||
(save-excursion
|
(save-excursion
|
||||||
(with-silent-modifications
|
(with-silent-modifications
|
||||||
(let* ((rep (make-progress-reporter
|
(let* ((rep (make-progress-reporter
|
||||||
|
@ -548,7 +548,7 @@ associated with an ERC session."
|
|||||||
"Speedbar update period.")
|
"Speedbar update period.")
|
||||||
|
|
||||||
(defvar-local erc-speedbar--last-ran nil
|
(defvar-local erc-speedbar--last-ran nil
|
||||||
"When non-nil, a lisp timestamp updated when the speedbar timer runs.")
|
"When non-nil, a Lisp timestamp updated when the speedbar timer runs.")
|
||||||
|
|
||||||
(defun erc-speedbar--prod-dframe-timer (&rest _)
|
(defun erc-speedbar--prod-dframe-timer (&rest _)
|
||||||
"Refresh speedbar if dormant for `erc-speedbar--force-update-interval-secs'."
|
"Refresh speedbar if dormant for `erc-speedbar--force-update-interval-secs'."
|
||||||
|
@ -210,11 +210,11 @@ from entering them and instead jump over them."
|
|||||||
|
|
||||||
(defvar erc-stamp--current-time nil
|
(defvar erc-stamp--current-time nil
|
||||||
"The current time when calling `erc-insert-timestamp-function'.
|
"The current time when calling `erc-insert-timestamp-function'.
|
||||||
Specifically, this is the same lisp time object used to create
|
Specifically, this is the same Lisp time object used to create
|
||||||
the stamp passed to `erc-insert-timestamp-function'.")
|
the stamp passed to `erc-insert-timestamp-function'.")
|
||||||
|
|
||||||
(cl-defgeneric erc-stamp--current-time ()
|
(cl-defgeneric erc-stamp--current-time ()
|
||||||
"Return a lisp time object to associate with an IRC message.
|
"Return a Lisp time object to associate with an IRC message.
|
||||||
This becomes the message's `erc--ts' text property."
|
This becomes the message's `erc--ts' text property."
|
||||||
(erc-compat--current-lisp-time))
|
(erc-compat--current-lisp-time))
|
||||||
|
|
||||||
|
@ -760,7 +760,7 @@ the number of unread messages, according to variables
|
|||||||
`erc-track-showcount' and `erc-track-showcount-string'.
|
`erc-track-showcount' and `erc-track-showcount-string'.
|
||||||
|
|
||||||
If `erc-track-use-faces' is true and FACES are provided, format
|
If `erc-track-use-faces' is true and FACES are provided, format
|
||||||
STRING with them. When the mouse hovers above the button, STRING
|
STRING with them. When the mouse hovers above the button, STRING
|
||||||
is displayed according to `erc-track-mouse-face'."
|
is displayed according to `erc-track-mouse-face'."
|
||||||
;; We define a new sparse keymap every time, because 1. this data
|
;; We define a new sparse keymap every time, because 1. this data
|
||||||
;; structure is very small, the alternative would require us to
|
;; structure is very small, the alternative would require us to
|
||||||
|
@ -1868,7 +1868,7 @@ the value of this option is DISPLAY-FUNCTION."
|
|||||||
"How to display buffers as a result of user interaction.
|
"How to display buffers as a result of user interaction.
|
||||||
This affects commands like /QUERY and /JOIN when issued
|
This affects commands like /QUERY and /JOIN when issued
|
||||||
interactively at the prompt. It does not apply when calling a
|
interactively at the prompt. It does not apply when calling a
|
||||||
handler for such a command, like `erc-cmd-JOIN', from lisp code.
|
handler for such a command, like `erc-cmd-JOIN', from Lisp code.
|
||||||
See `erc-buffer-display' for a full description of available
|
See `erc-buffer-display' for a full description of available
|
||||||
values.
|
values.
|
||||||
|
|
||||||
@ -2269,7 +2269,7 @@ buffer rather than a server buffer.")
|
|||||||
list match menu move-to-prompt netsplit
|
list match menu move-to-prompt netsplit
|
||||||
networks readonly ring stamp track)
|
networks readonly ring stamp track)
|
||||||
"Modules to enable while connecting.
|
"Modules to enable while connecting.
|
||||||
When modifying this option in lisp code, use a Custom-friendly
|
When modifying this option in Lisp code, use a Custom-friendly
|
||||||
facilitator, like `setopt', or call `erc-update-modules'
|
facilitator, like `setopt', or call `erc-update-modules'
|
||||||
afterward. This ensures a consistent ordering and disables
|
afterward. This ensures a consistent ordering and disables
|
||||||
removed modules. It also gives packages access to the hook
|
removed modules. It also gives packages access to the hook
|
||||||
@ -4476,7 +4476,7 @@ Called with position indicating boundary of interval to be excised.")
|
|||||||
(defun erc-cmd-CLEAR ()
|
(defun erc-cmd-CLEAR ()
|
||||||
"Clear messages in current buffer after informing active modules.
|
"Clear messages in current buffer after informing active modules.
|
||||||
Expect modules to perform housekeeping tasks to withstand the
|
Expect modules to perform housekeeping tasks to withstand the
|
||||||
disruption. When called from lisp code, only clear messages up
|
disruption. When called from Lisp code, only clear messages up
|
||||||
to but not including the one occupying the current line."
|
to but not including the one occupying the current line."
|
||||||
(with-silent-modifications
|
(with-silent-modifications
|
||||||
(let ((max (if (>= (point) erc-insert-marker)
|
(let ((max (if (>= (point) erc-insert-marker)
|
||||||
@ -7288,7 +7288,7 @@ status switches among VOICE, HALFOP, OP, ADMIN, and OWNER to be
|
|||||||
the symbol `on' or `off' when needing to influence a new or
|
the symbol `on' or `off' when needing to influence a new or
|
||||||
existing `erc-channel-user' object's `status' slot. Likewise,
|
existing `erc-channel-user' object's `status' slot. Likewise,
|
||||||
when UPDATE-MESSAGE-TIME is non-nil, update or initialize the
|
when UPDATE-MESSAGE-TIME is non-nil, update or initialize the
|
||||||
`last-message-time' slot to the current-time. If changes occur,
|
`last-message-time' slot to the `current-time'. If changes occur,
|
||||||
including creation, run `erc-channel-members-changed-hook'.
|
including creation, run `erc-channel-members-changed-hook'.
|
||||||
Return non-nil when meaningful changes, including creation, have
|
Return non-nil when meaningful changes, including creation, have
|
||||||
occurred.
|
occurred.
|
||||||
@ -9173,7 +9173,7 @@ Currently only used by the option `erc-prompt-format'.")
|
|||||||
;; As of ERC 5.6, this is identical to the away variant aside from
|
;; As of ERC 5.6, this is identical to the away variant aside from
|
||||||
;; the var names and `eq', which isn't important.
|
;; the var names and `eq', which isn't important.
|
||||||
(defun erc--format-user-modes ()
|
(defun erc--format-user-modes ()
|
||||||
"Return server's user modes as a string"
|
"Return server's user modes as a string."
|
||||||
(and-let* ((indicator (erc-with-server-buffer
|
(and-let* ((indicator (erc-with-server-buffer
|
||||||
(or erc--user-modes-indicator
|
(or erc--user-modes-indicator
|
||||||
(setq erc--user-modes-indicator (list "")))))
|
(setq erc--user-modes-indicator (list "")))))
|
||||||
@ -9730,7 +9730,7 @@ or `erc-kill-buffer-hook' if any other buffer."
|
|||||||
(defun erc-check-text-conversion ()
|
(defun erc-check-text-conversion ()
|
||||||
"Check if point is within the ERC prompt and toggle text conversion.
|
"Check if point is within the ERC prompt and toggle text conversion.
|
||||||
If `text-conversion-style' is not `action' if point is within the
|
If `text-conversion-style' is not `action' if point is within the
|
||||||
prompt or `nil' otherwise, set it to such a value, so as to
|
prompt or nil otherwise, set it to such a value, so as to
|
||||||
guarantee that the input method functions properly for the
|
guarantee that the input method functions properly for the
|
||||||
purpose of typing within the ERC prompt."
|
purpose of typing within the ERC prompt."
|
||||||
(when (and (eq major-mode 'erc-mode)
|
(when (and (eq major-mode 'erc-mode)
|
||||||
|
Loading…
Reference in New Issue
Block a user