aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2024-07-08 17:07:03 +0200
committerStefan Kangas2024-07-08 17:10:40 +0200
commite19fd6a22de00465b8fa6db574d71d03fa37b11f (patch)
tree36f334293a2a66626cc3f0638a07100d272c6ab4
parent7350457c793f5f6b7cd331b85ef5779ca17a1c27 (diff)
downloademacs-e19fd6a22de00465b8fa6db574d71d03fa37b11f.tar.gz
emacs-e19fd6a22de00465b8fa6db574d71d03fa37b11f.zip
Checkdoc fixes in `gnus/*.el`
* lisp/gnus/gnus-agent.el (gnus-agent-enable-expiration) (gnus-agent-with-refreshed-group, gnus-agentize) (gnus-agent-fetch-headers, gnus-agent-update-files-total-fetched-for) (gnus-agent-update-view-total-fetched-for): * lisp/gnus/gnus-art.el (gnus-article-address-banner-alist) (gnus-default-article-saver, gnus-mime-view-part-as-charset) (gnus-block-private-groups, gnus-article-edit-mode): * lisp/gnus/gnus-dired.el (gnus-dired-mode, gnus-dired-attach) (gnus-dired-find-file-mailcap, gnus-dired-print): * lisp/gnus/gnus-msg.el (gnus-summary-attach-article): * lisp/gnus/gnus-score.el (gnus-home-score-file): * lisp/gnus/gnus-search.el (gnus-search-ignored-newsgroups) (gnus-search-mu-switches, gnus-search-mu-remove-prefix) (gnus-search-thread): * lisp/gnus/gnus-sieve.el (gnus-sieve-string-list): * lisp/gnus/message.el (message-beginning-of-line): * lisp/gnus/mm-url.el: * lisp/gnus/mm-view.el (mm-w3m-setup, mm-setup-w3m): * lisp/gnus/mml-sec.el (mml-signencrypt-style): * lisp/gnus/nndiary.el: * lisp/gnus/nnimap.el (nnimap-server-port, nnimap-use-namespaces) (nnimap-expunge): * lisp/gnus/nnmail.el (nnmail-incoming-coding-system): (nnmail-ignore-broken-references): * lisp/gnus/nnmairix.el (nnmairix-default-group): * lisp/gnus/nntp.el (nntp-report): * lisp/gnus/nnvirtual.el (nnvirtual-update-read-and-marked): (nnvirtual-partition-sequence): * lisp/gnus/spam-stat.el (spam-stat-process-directory-age) (spam-stat-last-saved-at, spam-stat-save): * lisp/gnus/spam.el (spam-enter-ham-BBDB, spam-check-BBDB): Checkdoc fixes.
-rw-r--r--lisp/gnus/gnus-agent.el30
-rw-r--r--lisp/gnus/gnus-art.el29
-rw-r--r--lisp/gnus/gnus-dired.el14
-rw-r--r--lisp/gnus/gnus-msg.el2
-rw-r--r--lisp/gnus/gnus-score.el2
-rw-r--r--lisp/gnus/gnus-search.el9
-rw-r--r--lisp/gnus/gnus-sieve.el3
-rw-r--r--lisp/gnus/message.el5
-rw-r--r--lisp/gnus/mm-url.el2
-rw-r--r--lisp/gnus/mm-view.el4
-rw-r--r--lisp/gnus/mml-sec.el7
-rw-r--r--lisp/gnus/nndiary.el20
-rw-r--r--lisp/gnus/nnimap.el12
-rw-r--r--lisp/gnus/nnmail.el4
-rw-r--r--lisp/gnus/nnmairix.el7
-rw-r--r--lisp/gnus/nntp.el7
-rw-r--r--lisp/gnus/nnvirtual.el5
-rw-r--r--lisp/gnus/spam-stat.el6
-rw-r--r--lisp/gnus/spam.el4
19 files changed, 84 insertions, 88 deletions
diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el
index 0928b179787..c290f8537e2 100644
--- a/lisp/gnus/gnus-agent.el
+++ b/lisp/gnus/gnus-agent.el
@@ -153,7 +153,7 @@ this limit."
153When set to ENABLE, the default, `gnus-agent-expire' will expire old 153When set to ENABLE, the default, `gnus-agent-expire' will expire old
154contents from a group's local storage. This value may be overridden 154contents from a group's local storage. This value may be overridden
155to disable expiration in specific categories, topics, and groups. Of 155to disable expiration in specific categories, topics, and groups. Of
156course, you could change gnus-agent-enable-expiration to DISABLE then 156course, you could change `gnus-agent-enable-expiration' to DISABLE then
157enable expiration per categories, topics, and groups." 157enable expiration per categories, topics, and groups."
158 :version "22.1" 158 :version "22.1"
159 :group 'gnus-agent 159 :group 'gnus-agent
@@ -275,14 +275,14 @@ Actually a hash table holding subjects mapped to t.")
275;;; 275;;;
276 276
277(defmacro gnus-agent-with-refreshed-group (group &rest body) 277(defmacro gnus-agent-with-refreshed-group (group &rest body)
278 "Performs the body then updates the group's line in the group 278 "Perform the body then update the group's line in the group buffer.
279buffer. Automatically blocks multiple updates due to recursion." 279Automatically block multiple updates due to recursion."
280 `(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body) 280 `(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body)
281 (when (and gnus-agent-need-update-total-fetched-for 281 (when (and gnus-agent-need-update-total-fetched-for
282 (not gnus-agent-inhibit-update-total-fetched-for)) 282 (not gnus-agent-inhibit-update-total-fetched-for))
283 (with-current-buffer gnus-group-buffer 283 (with-current-buffer gnus-group-buffer
284 (setq gnus-agent-need-update-total-fetched-for nil) 284 (setq gnus-agent-need-update-total-fetched-for nil)
285 (gnus-group-update-group ,group t))))) 285 (gnus-group-update-group ,group t)))))
286 286
287(defun gnus-agent-read-file (file) 287(defun gnus-agent-read-file (file)
288 "Load FILE and do a `read' there." 288 "Load FILE and do a `read' there."
@@ -618,8 +618,8 @@ manipulated as follows:
618(defun gnus-agentize () 618(defun gnus-agentize ()
619 "Allow Gnus to be an offline newsreader. 619 "Allow Gnus to be an offline newsreader.
620 620
621The gnus-agentize function is now called internally by gnus when 621The `gnus-agentize' function is now called internally by gnus when
622gnus-agent is set. If you wish to avoid calling gnus-agentize, 622`gnus-agent' is set. If you wish to avoid calling `gnus-agentize',
623customize `gnus-agent' to nil. 623customize `gnus-agent' to nil.
624 624
625This will modify the `gnus-setup-news-hook', and 625This will modify the `gnus-setup-news-hook', and
@@ -1785,9 +1785,9 @@ variables. Returns the first non-nil value found."
1785 (agent-predicate . gnus-agent-predicate))))))) 1785 (agent-predicate . gnus-agent-predicate)))))))
1786 1786
1787(defun gnus-agent-fetch-headers (group) 1787(defun gnus-agent-fetch-headers (group)
1788 "Fetch interesting headers into the agent. The group's overview 1788 "Fetch interesting headers into the agent.
1789file will be updated to include the headers while a list of available 1789The group's overview file will be updated to include the headers while a
1790article numbers will be returned." 1790list of available article numbers will be returned."
1791 (let* ((fetch-all (and gnus-agent-consider-all-articles 1791 (let* ((fetch-all (and gnus-agent-consider-all-articles
1792 ;; Do not fetch all headers if the predicate 1792 ;; Do not fetch all headers if the predicate
1793 ;; implies that we only consider unread articles. 1793 ;; implies that we only consider unread articles.
@@ -4059,8 +4059,7 @@ CLEAN is obsolete and ignored."
4059 4059
4060(defun gnus-agent-update-files-total-fetched-for (group delta 4060(defun gnus-agent-update-files-total-fetched-for (group delta
4061 &optional method path) 4061 &optional method path)
4062 "Update, or set, the total disk space used by the articles that the 4062 "Update or set total disk space used by articles that the agent has fetched."
4063agent has fetched."
4064 (when gnus-agent-total-fetched-hashtb 4063 (when gnus-agent-total-fetched-hashtb
4065 (gnus-agent-with-refreshed-group 4064 (gnus-agent-with-refreshed-group
4066 group 4065 group
@@ -4099,9 +4098,8 @@ agent has fetched."
4099 4098
4100(defun gnus-agent-update-view-total-fetched-for 4099(defun gnus-agent-update-view-total-fetched-for
4101 (group agent-over &optional method path) 4100 (group agent-over &optional method path)
4102 "Update, or set, the total disk space used by the .agentview and 4101 "Update or set the total disk space used by the .agentview and .overview files.
4103.overview files. These files are calculated separately as they can be 4102These files are calculated separately as they can be modified."
4104modified."
4105 (when gnus-agent-total-fetched-hashtb 4103 (when gnus-agent-total-fetched-hashtb
4106 (gnus-agent-with-refreshed-group 4104 (gnus-agent-with-refreshed-group
4107 group 4105 group
diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el
index 9f313108089..5151ad1c1b8 100644
--- a/lisp/gnus/gnus-art.el
+++ b/lisp/gnus/gnus-art.el
@@ -330,8 +330,7 @@ to match a mail address in the From: header, BANNER is one of a symbol
330If ADDRESS matches author's mail address, it will remove things like 330If ADDRESS matches author's mail address, it will remove things like
331advertisements. For example: 331advertisements. For example:
332 332
333\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\")) 333\((\"@yoo-hoo\\\\.co\\\\.jp\\\\\\='\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))"
334"
335 :type '(repeat 334 :type '(repeat
336 (cons 335 (cons
337 (regexp :tag "Address") 336 (regexp :tag "Address")
@@ -557,15 +556,15 @@ command, and friends such as `gnus-summary-save-article-rmail'.
557 556
558Gnus provides the following functions: 557Gnus provides the following functions:
559 558
560* gnus-summary-save-in-rmail (Rmail format) 559* `gnus-summary-save-in-rmail' (Rmail format)
561* gnus-summary-save-in-mail (Unix mail format) 560* `gnus-summary-save-in-mail' (Unix mail format)
562* gnus-summary-save-in-folder (MH folder) 561* `gnus-summary-save-in-folder' (MH folder)
563* gnus-summary-save-in-file (article format) 562* `gnus-summary-save-in-file' (article format)
564* gnus-summary-save-body-in-file (article body) 563* `gnus-summary-save-body-in-file' (article body)
565* gnus-summary-save-in-vm (use VM's folder format) 564* `gnus-summary-save-in-vm' (use VM's folder format)
566* gnus-summary-write-to-file (article format -- overwrite) 565* `gnus-summary-write-to-file' (article format -- overwrite)
567* gnus-summary-write-body-to-file (article body -- overwrite) 566* `gnus-summary-write-body-to-file' (article body -- overwrite)
568* gnus-summary-save-in-pipe (article format) 567* `gnus-summary-save-in-pipe' (article format)
569 568
570The symbol of each function may have the following properties: 569The symbol of each function may have the following properties:
571 570
@@ -5519,8 +5518,7 @@ CHARSET may either be a string or a symbol."
5519 (setcdr type (cons (cons 'charset charset) (cdr type))))))) 5518 (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5520 5519
5521(defun gnus-mime-view-part-as-charset (&optional handle arg event) 5520(defun gnus-mime-view-part-as-charset (&optional handle arg event)
5522 "Insert the MIME part under point into the current buffer using the 5521 "Insert MIME part under point into current buffer using specified charset."
5523specified charset."
5524 (interactive (list nil current-prefix-arg last-nonmenu-event) 5522 (interactive (list nil current-prefix-arg last-nonmenu-event)
5525 gnus-article-mode) 5523 gnus-article-mode)
5526 (save-excursion 5524 (save-excursion
@@ -7304,8 +7302,7 @@ If given a prefix, show the hidden text instead."
7304 (point))))))) 7302 (point)))))))
7305 7303
7306(defun gnus-block-private-groups (group) 7304(defun gnus-block-private-groups (group)
7307 "Allows images in newsgroups to be shown, blocks images in all 7305 "Allows images in newsgroups to be shown, blocks images in all other groups."
7308other groups."
7309 (if (or (gnus-news-group-p group) 7306 (if (or (gnus-news-group-p group)
7310 (gnus-member-of-valid 'global group) 7307 (gnus-member-of-valid 'global group)
7311 (member group gnus-global-groups)) 7308 (member group gnus-global-groups))
@@ -7389,7 +7386,7 @@ other groups."
7389 7386
7390(define-derived-mode gnus-article-edit-mode message-mode "Article Edit" 7387(define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
7391 "Major mode for editing articles. 7388 "Major mode for editing articles.
7392This is an extended text-mode. 7389This is an extended `text-mode'.
7393 7390
7394\\{gnus-article-edit-mode-map}" 7391\\{gnus-article-edit-mode-map}"
7395 (make-local-variable 'gnus-article-edit-done-function) 7392 (make-local-variable 'gnus-article-edit-done-function)
diff --git a/lisp/gnus/gnus-dired.el b/lisp/gnus/gnus-dired.el
index f33c5f7f2e5..f21d84b40c6 100644
--- a/lisp/gnus/gnus-dired.el
+++ b/lisp/gnus/gnus-dired.el
@@ -24,15 +24,15 @@
24;;; Commentary: 24;;; Commentary:
25 25
26;; This package provides utility functions for intersections of gnus 26;; This package provides utility functions for intersections of gnus
27;; and dired. To enable the gnus-dired-mode minor mode which will 27;; and Dired. To enable the gnus-dired-mode minor mode which will
28;; have the effect of installing keybindings in dired-mode, place the 28;; have the effect of installing keybindings in dired-mode, place the
29;; following in your ~/.gnus: 29;; following in your ~/.gnus:
30 30
31;; (require 'gnus-dired) ;, isn't needed due to autoload cookies 31;; (require 'gnus-dired) ;, isn't needed due to autoload cookies
32;; (add-hook 'dired-mode-hook #'turn-on-gnus-dired-mode) 32;; (add-hook 'dired-mode-hook #'turn-on-gnus-dired-mode)
33 33
34;; Note that if you visit dired buffers before your ~/.gnus file has 34;; Note that if you visit Dired buffers before your ~/.gnus file has
35;; been read, those dired buffers won't have the keybindings in 35;; been read, those Dired buffers won't have the keybindings in
36;; effect. To get around that problem, you may want to add the above 36;; effect. To get around that problem, you may want to add the above
37;; statements to your ~/.emacs instead. 37;; statements to your ~/.emacs instead.
38 38
@@ -81,7 +81,7 @@ See `mail-user-agent' for more information."
81 (function :tag "Other"))) 81 (function :tag "Other")))
82 82
83(define-minor-mode gnus-dired-mode 83(define-minor-mode gnus-dired-mode
84 "Minor mode for intersections of gnus and dired. 84 "Minor mode for intersections of gnus and Dired.
85 85
86\\{gnus-dired-mode-map}" 86\\{gnus-dired-mode-map}"
87 :keymap gnus-dired-mode-map 87 :keymap gnus-dired-mode-map
@@ -119,7 +119,7 @@ See `mail-user-agent' for more information."
119 119
120;; Method to attach files to a mail composition. 120;; Method to attach files to a mail composition.
121(defun gnus-dired-attach (files-to-attach) 121(defun gnus-dired-attach (files-to-attach)
122 "Attach dired's marked files to a gnus message composition. 122 "Attach Dired's marked files to a gnus message composition.
123If called non-interactively, FILES-TO-ATTACH should be a list of 123If called non-interactively, FILES-TO-ATTACH should be a list of
124filenames." 124filenames."
125 (interactive 125 (interactive
@@ -180,7 +180,7 @@ filenames."
180(autoload 'mailcap-parse-mailcaps "mailcap" "" t) 180(autoload 'mailcap-parse-mailcaps "mailcap" "" t)
181 181
182(defun gnus-dired-find-file-mailcap (&optional file-name arg) 182(defun gnus-dired-find-file-mailcap (&optional file-name arg)
183 "In dired, visit FILE-NAME according to the mailcap file. 183 "In Dired, visit FILE-NAME according to the mailcap file.
184If ARG is non-nil, open it in a new buffer." 184If ARG is non-nil, open it in a new buffer."
185 (interactive (list 185 (interactive (list
186 (file-name-sans-versions (dired-get-filename) t) 186 (file-name-sans-versions (dired-get-filename) t)
@@ -215,7 +215,7 @@ If ARG is non-nil, open it in a new buffer."
215 "File no longer exists; type \\`g' to update Dired buffer"))))) 215 "File no longer exists; type \\`g' to update Dired buffer")))))
216 216
217(defun gnus-dired-print (&optional file-name print-to) 217(defun gnus-dired-print (&optional file-name print-to)
218 "In dired, print FILE-NAME according to the mailcap file. 218 "In Dired, print FILE-NAME according to the mailcap file.
219 219
220If there is no print command, print in a PostScript image. If the 220If there is no print command, print in a PostScript image. If the
221optional argument PRINT-TO is nil, send the image to the printer. 221optional argument PRINT-TO is nil, send the image to the printer.
diff --git a/lisp/gnus/gnus-msg.el b/lisp/gnus/gnus-msg.el
index b18ede58fbf..705dbfa10f2 100644
--- a/lisp/gnus/gnus-msg.el
+++ b/lisp/gnus/gnus-msg.el
@@ -1918,7 +1918,7 @@ can be attached to them. If not, a new Message buffer is
1918created. 1918created.
1919 1919
1920This command uses the process/prefix convention, so if you 1920This command uses the process/prefix convention, so if you
1921process-mark several articles, they will all be attached." 1921`process-mark' several articles, they will all be attached."
1922 (interactive "P" gnus-summary-mode) 1922 (interactive "P" gnus-summary-mode)
1923 (let ((buffers (message-buffers)) 1923 (let ((buffers (message-buffers))
1924 destination) 1924 destination)
diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el
index 31ce1328e37..f91299ed3c0 100644
--- a/lisp/gnus/gnus-score.el
+++ b/lisp/gnus/gnus-score.el
@@ -190,7 +190,7 @@ It can be:
190 * `(regexp file-name ...)' 190 * `(regexp file-name ...)'
191 If the `regexp' matches the group name, the first `file-name' 191 If the `regexp' matches the group name, the first `file-name'
192 will be used as the home score file. (Multiple filenames are 192 will be used as the home score file. (Multiple filenames are
193 allowed so that one may use gnus-score-file-single-match-alist to 193 allowed so that one may use `gnus-score-file-single-match-alist' to
194 set this variable.) 194 set this variable.)
195 195
196 * A function. 196 * A function.
diff --git a/lisp/gnus/gnus-search.el b/lisp/gnus/gnus-search.el
index 9cff2e2f109..c25163ac770 100644
--- a/lisp/gnus/gnus-search.el
+++ b/lisp/gnus/gnus-search.el
@@ -135,8 +135,7 @@ transformed."
135 'gnus-search-ignored-newsgroups "28.1") 135 'gnus-search-ignored-newsgroups "28.1")
136 136
137(defcustom gnus-search-ignored-newsgroups "" 137(defcustom gnus-search-ignored-newsgroups ""
138 "A regexp to match newsgroups in the active file that should 138 "Regexp matching newsgroups in the active file to skip when searching."
139be skipped when searching."
140 :version "24.1" 139 :version "24.1"
141 :type 'regexp) 140 :type 'regexp)
142 141
@@ -357,7 +356,7 @@ This can also be set per-server."
357 356
358(defcustom gnus-search-mu-switches nil 357(defcustom gnus-search-mu-switches nil
359 "A list of strings, to be given as additional arguments to mu. 358 "A list of strings, to be given as additional arguments to mu.
360Note that this should be a list. I.e., do NOT use the following: 359Note that this should be a list. I.e., do NOT use the following:
361 (setq gnus-search-mu-switches \"-u -r\") 360 (setq gnus-search-mu-switches \"-u -r\")
362Instead, use this: 361Instead, use this:
363 (setq gnus-search-mu-switches \\='(\"-u\" \"-r\")) 362 (setq gnus-search-mu-switches \\='(\"-u\" \"-r\"))
@@ -367,7 +366,7 @@ This can also be set per-server."
367 366
368(defcustom gnus-search-mu-remove-prefix (expand-file-name "~/Mail/") 367(defcustom gnus-search-mu-remove-prefix (expand-file-name "~/Mail/")
369 "A prefix to remove from the mu results to get a group name. 368 "A prefix to remove from the mu results to get a group name.
370Usually this will be set to the path to your mail directory. This 369Usually this will be set to the path to your mail directory. This
371can also be set per-server." 370can also be set per-server."
372 :version "29.1" 371 :version "29.1"
373 :type 'directory) 372 :type 'directory)
@@ -2186,7 +2185,7 @@ remaining string, then adds all that to the top-level spec."
2186 2185
2187(defun gnus-search-thread (header &optional group server) 2186(defun gnus-search-thread (header &optional group server)
2188 "Find articles in the thread containing HEADER from GROUP on SERVER. 2187 "Find articles in the thread containing HEADER from GROUP on SERVER.
2189If gnus-refer-thread-use-search is nil only the current group is 2188If `gnus-refer-thread-use-search' is nil only the current group is
2190checked for articles; if t all groups on the server containing 2189checked for articles; if t all groups on the server containing
2191the article's group will be searched; if a list then all servers 2190the article's group will be searched; if a list then all servers
2192in this list will be searched. If possible the newly found 2191in this list will be searched. If possible the newly found
diff --git a/lisp/gnus/gnus-sieve.el b/lisp/gnus/gnus-sieve.el
index 04af180a9d2..7b4561b52f5 100644
--- a/lisp/gnus/gnus-sieve.el
+++ b/lisp/gnus/gnus-sieve.el
@@ -133,8 +133,7 @@ Return nil if no rule could be guessed."
133 133
134For example: 134For example:
135\(gnus-sieve-string-list \\='(\"to\" \"cc\")) 135\(gnus-sieve-string-list \\='(\"to\" \"cc\"))
136 => \"[\\\"to\\\", \\\"cc\\\"]\" 136 => \"[\\\"to\\\", \\\"cc\\\"]\""
137"
138 (concat "[\"" (mapconcat #'identity list "\", \"") "\"]")) 137 (concat "[\"" (mapconcat #'identity list "\", \"") "\"]"))
139 138
140(defun gnus-sieve-test-list (list) 139(defun gnus-sieve-test-list (list)
diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el
index 0a46f3a2fed..98f63571389 100644
--- a/lisp/gnus/message.el
+++ b/lisp/gnus/message.el
@@ -6605,8 +6605,7 @@ they are."
6605 (sit-for 0)) 6605 (sit-for 0))
6606 6606
6607(defcustom message-beginning-of-line t 6607(defcustom message-beginning-of-line t
6608 "Whether \\<message-mode-map>\\[message-beginning-of-line]\ 6608 "Whether \\<message-mode-map>\\[message-beginning-of-line] goes to beginning of header values."
6609 goes to beginning of header values."
6610 :version "22.1" 6609 :version "22.1"
6611 :group 'message-buffers 6610 :group 'message-buffers
6612 :link '(custom-manual "(message)Movement") 6611 :link '(custom-manual "(message)Movement")
@@ -6668,7 +6667,7 @@ beginning of line.
6668When called without a prefix argument, header value spanning 6667When called without a prefix argument, header value spanning
6669multiple lines is treated as a single line. Otherwise, even if 6668multiple lines is treated as a single line. Otherwise, even if
6670N is 1, when point is on a continuation header line, it will be 6669N is 1, when point is on a continuation header line, it will be
6671moved to the beginning " 6670moved to the beginning."
6672 (interactive "^p" message-mode) 6671 (interactive "^p" message-mode)
6673 (cond 6672 (cond
6674 ;; Go to beginning of header or beginning of line. 6673 ;; Go to beginning of header or beginning of line.
diff --git a/lisp/gnus/mm-url.el b/lisp/gnus/mm-url.el
index be6c9bb7977..788e4b294a0 100644
--- a/lisp/gnus/mm-url.el
+++ b/lisp/gnus/mm-url.el
@@ -21,7 +21,7 @@
21 21
22;;; Commentary: 22;;; Commentary:
23 23
24;; Some code is stolen from w3 and url packages. Some are moved from 24;; Some code is stolen from w3 and url packages. Some are moved from
25;; nnweb. 25;; nnweb.
26 26
27;; TODO: Support POST, cookie. 27;; TODO: Support POST, cookie.
diff --git a/lisp/gnus/mm-view.el b/lisp/gnus/mm-view.el
index 223da19a164..1df634d3c9b 100644
--- a/lisp/gnus/mm-view.el
+++ b/lisp/gnus/mm-view.el
@@ -108,14 +108,14 @@ This is only used if `mm-inline-large-images' is set to
108 (delete-region b (+ b 2))))))) 108 (delete-region b (+ b 2)))))))
109 109
110(defvar mm-w3m-setup nil 110(defvar mm-w3m-setup nil
111 "Whether gnus-article-mode has been setup to use emacs-w3m.") 111 "Whether `gnus-article-mode' has been setup to use emacs-w3m.")
112 112
113;; External. 113;; External.
114(declare-function w3m-detect-meta-charset "ext:w3m" ()) 114(declare-function w3m-detect-meta-charset "ext:w3m" ())
115(declare-function w3m-region "ext:w3m" (start end &optional url charset)) 115(declare-function w3m-region "ext:w3m" (start end &optional url charset))
116 116
117(defun mm-setup-w3m () 117(defun mm-setup-w3m ()
118 "Setup gnus-article-mode to use emacs-w3m." 118 "Setup `gnus-article-mode' to use emacs-w3m."
119 (unless mm-w3m-setup 119 (unless mm-w3m-setup
120 (require 'w3m) 120 (require 'w3m)
121 (unless (assq 'gnus-article-mode w3m-cid-retrieve-function-alist) 121 (unless (assq 'gnus-article-mode w3m-cid-retrieve-function-alist)
diff --git a/lisp/gnus/mml-sec.el b/lisp/gnus/mml-sec.el
index 98f8ebbcbcd..141e00223db 100644
--- a/lisp/gnus/mml-sec.el
+++ b/lisp/gnus/mml-sec.el
@@ -151,9 +151,10 @@ you use Bcc headers to encrypt e-mails to yourself."
151;;; Configuration/helper functions 151;;; Configuration/helper functions
152 152
153(defun mml-signencrypt-style (method &optional style) 153(defun mml-signencrypt-style (method &optional style)
154 "Function for setting/getting the signencrypt-style used. Takes two 154 "Function for setting/getting the signencrypt-style used.
155arguments, the method (e.g. \"pgp\") and optionally the mode 155Takes two arguments, the method (e.g. \"pgp\") and optionally the mode
156\(e.g. combined). If the mode is omitted, the current value is returned. 156\(e.g. combined). If the mode is omitted, the current value is
157returned.
157 158
158For example, if you prefer to use combined sign & encrypt with 159For example, if you prefer to use combined sign & encrypt with
159smime, putting the following in your Gnus startup file will 160smime, putting the following in your Gnus startup file will
diff --git a/lisp/gnus/nndiary.el b/lisp/gnus/nndiary.el
index b6f423ee2f8..97a4600603f 100644
--- a/lisp/gnus/nndiary.el
+++ b/lisp/gnus/nndiary.el
@@ -30,7 +30,7 @@
30;; =========== 30;; ===========
31 31
32;; nndiary is a mail back end designed to handle mails as diary event 32;; nndiary is a mail back end designed to handle mails as diary event
33;; reminders. It is now fully documented in the Gnus manual. 33;; reminders. It is now fully documented in the Gnus manual.
34 34
35 35
36;; Bugs / Todo: 36;; Bugs / Todo:
@@ -43,19 +43,19 @@
43;; * We could allow a keyword like `ask' in X-Diary-* headers, that would mean 43;; * We could allow a keyword like `ask' in X-Diary-* headers, that would mean
44;; "ask for value upon reception of the message". 44;; "ask for value upon reception of the message".
45;; * We could add an optional header X-Diary-Reminders to specify a special 45;; * We could add an optional header X-Diary-Reminders to specify a special
46;; reminders value for this message. Suggested by Jody Klymak. 46;; reminders value for this message. Suggested by Jody Klymak.
47;; * We should check messages validity in other circumstances than just 47;; * We should check messages validity in other circumstances than just
48;; moving an article from somewhere else (request-accept). For instance, 48;; moving an article from somewhere else (request-accept). For instance,
49;; when editing / saving and so on. 49;; when editing / saving and so on.
50 50
51 51
52;; Remarks: 52;; Remarks:
53;; ======= 53;; =======
54 54
55;; * nnoo. NNDiary is very similar to nnml. This makes the idea of using nnoo 55;; * nnoo. NNDiary is very similar to nnml. This makes the idea of using nnoo
56;; (to derive nndiary from nnml) natural. However, my experience with nnoo 56;; (to derive nndiary from nnml) natural. However, my experience with nnoo
57;; is that for reasonably complex back ends like this one, nnoo is a burden 57;; is that for reasonably complex back ends like this one, nnoo is a burden
58;; rather than an help. It's tricky to use, not everything can be inherited, 58;; rather than an help. It's tricky to use, not everything can be inherited,
59;; what can be inherited and when is not very clear, and you've got to be 59;; what can be inherited and when is not very clear, and you've got to be
60;; very careful because a little mistake can fuck up your other back ends, 60;; very careful because a little mistake can fuck up your other back ends,
61;; especially because their variables will be use instead of your real ones. 61;; especially because their variables will be use instead of your real ones.
@@ -64,16 +64,16 @@
64 64
65;; IMHO, nnoo is actually badly designed. A much simpler, and yet more 65;; IMHO, nnoo is actually badly designed. A much simpler, and yet more
66;; powerful one would be to make *real* functions and variables for a new 66;; powerful one would be to make *real* functions and variables for a new
67;; back end based on another. Lisp is a reflexive language so that's a very 67;; back end based on another. Lisp is a reflexive language so that's a very
68;; easy thing to do: inspect the function's form, replace occurrences of 68;; easy thing to do: inspect the function's form, replace occurrences of
69;; <nnfrom> (even in strings) with <nnto>, and you're done. 69;; <nnfrom> (even in strings) with <nnto>, and you're done.
70 70
71;; * nndiary-get-new-mail, nndiary-mail-source and nndiary-split-methods: 71;; * nndiary-get-new-mail, nndiary-mail-source and nndiary-split-methods:
72;; NNDiary has some experimental parts, in the sense Gnus normally uses only 72;; NNDiary has some experimental parts, in the sense Gnus normally uses only
73;; one mail back ends for mail retrieval and splitting. This back end is 73;; one mail back ends for mail retrieval and splitting. This back end is
74;; also an attempt to make it behave differently. For Gnus developers: as 74;; also an attempt to make it behave differently. For Gnus developers: as
75;; you can see if you snarf into the code, that was not a very difficult 75;; you can see if you snarf into the code, that was not a very difficult
76;; thing to do. Something should be done about the respooling breakage 76;; thing to do. Something should be done about the respooling breakage
77;; though. 77;; though.
78 78
79 79
diff --git a/lisp/gnus/nnimap.el b/lisp/gnus/nnimap.el
index c61dfecfa7a..7b0e42ff89d 100644
--- a/lisp/gnus/nnimap.el
+++ b/lisp/gnus/nnimap.el
@@ -51,7 +51,7 @@
51 51
52(defvoo nnimap-server-port nil 52(defvoo nnimap-server-port nil
53 "The IMAP port used. 53 "The IMAP port used.
54If nnimap-stream is `ssl', this will default to `imaps'. If not, 54If `nnimap-stream' is `ssl', this will default to `imaps'. If not,
55it will default to `imap'.") 55it will default to `imap'.")
56 56
57(defvoo nnimap-use-namespaces nil 57(defvoo nnimap-use-namespaces nil
@@ -59,7 +59,7 @@ it will default to `imap'.")
59If in Gnus your folder names in all start with (e.g.) `INBOX', 59If in Gnus your folder names in all start with (e.g.) `INBOX',
60you probably want to set this to t. The effects of this are 60you probably want to set this to t. The effects of this are
61purely cosmetic, but changing this variable will affect the 61purely cosmetic, but changing this variable will affect the
62names of your nnimap groups. ") 62names of your nnimap groups.")
63 63
64(defvoo nnimap-stream 'undecided 64(defvoo nnimap-stream 'undecided
65 "How nnimap talks to the IMAP server. 65 "How nnimap talks to the IMAP server.
@@ -102,15 +102,15 @@ Possible choices are nil (use default methods), `anonymous',
102(defvoo nnimap-expunge 'on-exit 102(defvoo nnimap-expunge 'on-exit
103 "When to expunge deleted messages. 103 "When to expunge deleted messages.
104If `never', deleted articles are marked with the IMAP \\Delete 104If `never', deleted articles are marked with the IMAP \\Delete
105flag but not automatically expunged. If `immediately', deleted 105flag but not automatically expunged. If `immediately', deleted
106articles are immediately expunged (this requires the server to 106articles are immediately expunged (this requires the server to
107support the UID EXPUNGE command). If `on-exit', deleted articles 107support the UID EXPUNGE command). If `on-exit', deleted articles
108are flagged, and all flagged articles are expunged when the group 108are flagged, and all flagged articles are expunged when the group
109is closed. 109is closed.
110 110
111For backwards compatibility, this variable may also be set to t 111For backwards compatibility, this variable may also be set to t
112or nil. If the server supports UID EXPUNGE, both t and nil are 112or nil. If the server supports UID EXPUNGE, both t and nil are
113equivalent to `immediately'. If the server does not support UID 113equivalent to `immediately'. If the server does not support UID
114EXPUNGE nil is equivalent to `never', while t will immediately 114EXPUNGE nil is equivalent to `never', while t will immediately
115expunge ALL articles that are currently flagged as deleted 115expunge ALL articles that are currently flagged as deleted
116(i.e., potentially not only the article that was just deleted).") 116(i.e., potentially not only the article that was just deleted).")
diff --git a/lisp/gnus/nnmail.el b/lisp/gnus/nnmail.el
index a9f5b89c6fe..afc6a7470ac 100644
--- a/lisp/gnus/nnmail.el
+++ b/lisp/gnus/nnmail.el
@@ -602,7 +602,7 @@ These will be logged to the \"*nnmail split*\" buffer."
602 602
603(defvar nnmail-incoming-coding-system 603(defvar nnmail-incoming-coding-system
604 mm-text-coding-system 604 mm-text-coding-system
605 "Coding system used in reading inbox") 605 "Coding system used in reading inbox.")
606 606
607(defcustom nnmail-pathname-coding-system nil 607(defcustom nnmail-pathname-coding-system nil
608 "Coding system for file name." 608 "Coding system for file name."
@@ -1306,7 +1306,7 @@ See `nnmail-ignore-broken-references'."
1306 :type 'regexp) 1306 :type 'regexp)
1307 1307
1308(defun nnmail-ignore-broken-references () 1308(defun nnmail-ignore-broken-references ()
1309 "Ignore the References line and use In-Reply-To 1309 "Ignore the References line and use In-Reply-To.
1310 1310
1311Eudora has a broken References line, but an OK In-Reply-To." 1311Eudora has a broken References line, but an OK In-Reply-To."
1312 (goto-char (point-min)) 1312 (goto-char (point-min))
diff --git a/lisp/gnus/nnmairix.el b/lisp/gnus/nnmairix.el
index c517f85db9b..434e907d536 100644
--- a/lisp/gnus/nnmairix.el
+++ b/lisp/gnus/nnmairix.el
@@ -35,7 +35,7 @@
35 35
36;; Commentary on the code: nnmairix sits between Gnus and the "real" 36;; Commentary on the code: nnmairix sits between Gnus and the "real"
37;; back end which handles the mail (currently nnml, nnimap and 37;; back end which handles the mail (currently nnml, nnimap and
38;; nnmaildir were tested). I know this is all a bit hacky, but so far 38;; nnmaildir were tested). I know this is all a bit hacky, but so far
39;; it works for me. This is the first back end I've written for Gnus, 39;; it works for me. This is the first back end I've written for Gnus,
40;; so I'd appreciate any comments, suggestions, bug reports (and, of 40;; so I'd appreciate any comments, suggestions, bug reports (and, of
41;; course, patches) for improving nnmairix. 41;; course, patches) for improving nnmairix.
@@ -368,8 +368,9 @@ wrong count of total articles shown by Gnus.")
368its maildir mail folders (e.g. the Dovecot IMAP server or mutt).") 368its maildir mail folders (e.g. the Dovecot IMAP server or mutt).")
369 369
370(defvoo nnmairix-default-group nil 370(defvoo nnmairix-default-group nil
371 "Default search group. This is the group which is used for all 371 "Default search group.
372temporary searches, e.g. nnmairix-search.") 372This is the group which is used for all temporary searches,
373e.g. nnmairix-search.")
373 374
374;;; === Internal variables 375;;; === Internal variables
375 376
diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el
index fe165662988..393fd01a5d1 100644
--- a/lisp/gnus/nntp.el
+++ b/lisp/gnus/nntp.el
@@ -300,9 +300,10 @@ backend doesn't catch this error.")
300(defvar nntp--report-1 nil) 300(defvar nntp--report-1 nil)
301 301
302(defun nntp-report (&rest args) 302(defun nntp-report (&rest args)
303 "Report an error from the nntp backend. The first string in ARGS 303 "Report an error from the nntp backend.
304can be a format string. For some commands, the failed command may be 304The first string in ARGS can be a format string. For some commands, the
305retried once before actually displaying the error report." 305failed command may be retried once before actually displaying the error
306report."
306 (if nntp--report-1 307 (if nntp--report-1
307 (progn 308 (progn
308 ;; Throw out to nntp-with-open-group-error so that the connection may 309 ;; Throw out to nntp-with-open-group-error so that the connection may
diff --git a/lisp/gnus/nnvirtual.el b/lisp/gnus/nnvirtual.el
index 9eea0f89996..79747dca31f 100644
--- a/lisp/gnus/nnvirtual.el
+++ b/lisp/gnus/nnvirtual.el
@@ -436,7 +436,8 @@ lines have the correct component server prefix."
436(defun nnvirtual-update-read-and-marked (read-p update-p) 436(defun nnvirtual-update-read-and-marked (read-p update-p)
437 "Copy marks from the virtual group to the component groups. 437 "Copy marks from the virtual group to the component groups.
438If READ-P is not nil, update the (un)read status of the components. 438If READ-P is not nil, update the (un)read status of the components.
439If UPDATE-P is not nil, call gnus-group-update-group on the components." 439If UPDATE-P is not nil, call `gnus-group-update-group' on the
440components."
440 (when nnvirtual-current-group 441 (when nnvirtual-current-group
441 (let ((unreads (and read-p 442 (let ((unreads (and read-p
442 (nnvirtual-partition-sequence 443 (nnvirtual-partition-sequence
@@ -642,7 +643,7 @@ then it is left out of the result."
642 643
643(defun nnvirtual-partition-sequence (articles) 644(defun nnvirtual-partition-sequence (articles)
644 "Return an association list of component article numbers. 645 "Return an association list of component article numbers.
645These are indexed by elements of nnvirtual-component-groups, based on 646These are indexed by elements of `nnvirtual-component-groups', based on
646the sequence ARTICLES of virtual article numbers. ARTICLES should be 647the sequence ARTICLES of virtual article numbers. ARTICLES should be
647sorted, and can be a compressed sequence. If any of the article 648sorted, and can be a compressed sequence. If any of the article
648numbers has no corresponding component article, then it is left out of 649numbers has no corresponding component article, then it is left out of
diff --git a/lisp/gnus/spam-stat.el b/lisp/gnus/spam-stat.el
index f4ad9e48f6f..431cb5e7d7a 100644
--- a/lisp/gnus/spam-stat.el
+++ b/lisp/gnus/spam-stat.el
@@ -183,7 +183,7 @@ say, `with-spam-stat-max-buffer-size'."
183 :type '(repeat sexp)) 183 :type '(repeat sexp))
184 184
185(defcustom spam-stat-process-directory-age 90 185(defcustom spam-stat-process-directory-age 90
186 "Max. age of files to be processed in directory, in days. 186 "Maximum age of files to be processed in directory, in days.
187When using `spam-stat-process-spam-directory' or 187When using `spam-stat-process-spam-directory' or
188`spam-stat-process-non-spam-directory', only files that have 188`spam-stat-process-non-spam-directory', only files that have
189been touched in this many days will be considered. Without 189been touched in this many days will be considered. Without
@@ -192,7 +192,7 @@ will start to take a very long time."
192 :type 'integer) 192 :type 'integer)
193 193
194(defvar spam-stat-last-saved-at nil 194(defvar spam-stat-last-saved-at nil
195 "Time stamp of last change of spam-stat-file on this run") 195 "Time stamp of last change of `spam-stat-file' on this run.")
196 196
197(defvar spam-stat-syntax-table 197(defvar spam-stat-syntax-table
198 (let ((table (copy-syntax-table text-mode-syntax-table))) 198 (let ((table (copy-syntax-table text-mode-syntax-table)))
@@ -394,7 +394,7 @@ Use `spam-stat-ngood', `spam-stat-nbad', `spam-stat-good',
394;; Saving and Loading 394;; Saving and Loading
395 395
396(defun spam-stat-save (&optional force) 396(defun spam-stat-save (&optional force)
397 "Save the `spam-stat' hash table as lisp file. 397 "Save the `spam-stat' hash table as Lisp file.
398With a prefix argument save unconditionally." 398With a prefix argument save unconditionally."
399 (interactive "P") 399 (interactive "P")
400 (when (or force spam-stat-dirty) 400 (when (or force spam-stat-dirty)
diff --git a/lisp/gnus/spam.el b/lisp/gnus/spam.el
index 1ae214ea4fa..ed667dae31f 100644
--- a/lisp/gnus/spam.el
+++ b/lisp/gnus/spam.el
@@ -2053,7 +2053,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
2053 (add-hook 'bbdb-change-hook #'spam-clear-cache-BBDB)) 2053 (add-hook 'bbdb-change-hook #'spam-clear-cache-BBDB))
2054 2054
2055(defun spam-enter-ham-BBDB (addresses &optional remove) 2055(defun spam-enter-ham-BBDB (addresses &optional remove)
2056 "Enter an address into the BBDB; implies ham (non-spam) sender" 2056 "Enter an address into the BBDB; implies ham (non-spam) sender."
2057 (dolist (from addresses) 2057 (dolist (from addresses)
2058 (when (stringp from) 2058 (when (stringp from)
2059 (let* ((parsed-address (gnus-extract-address-components from)) 2059 (let* ((parsed-address (gnus-extract-address-components from))
@@ -2091,7 +2091,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
2091 (bbdb-gethash (downcase net)))) 2091 (bbdb-gethash (downcase net))))
2092 2092
2093(defun spam-check-BBDB () 2093(defun spam-check-BBDB ()
2094 "Mail from people in the BBDB is classified as ham or non-spam" 2094 "Mail from people in the BBDB is classified as ham or non-spam."
2095 (let ((net (message-fetch-field "from"))) 2095 (let ((net (message-fetch-field "from")))
2096 (when net 2096 (when net
2097 (setq net (nth 1 (gnus-extract-address-components net))) 2097 (setq net (nth 1 (gnus-extract-address-components net)))