aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Love2000-10-12 16:41:22 +0000
committerDave Love2000-10-12 16:41:22 +0000
commit0a1280b2291ef8b0527a79c57d8464e1a36df83f (patch)
tree2af00e4b4d11d034ab6f075e9f1698380de2b82e
parentd9c9b920f97e1be36abae721d5dbb890bf754833 (diff)
downloademacs-0a1280b2291ef8b0527a79c57d8464e1a36df83f.tar.gz
emacs-0a1280b2291ef8b0527a79c57d8464e1a36df83f.zip
Maintainer's checkdoc fixes.
-rw-r--r--lisp/recentf.el44
1 files changed, 22 insertions, 22 deletions
diff --git a/lisp/recentf.el b/lisp/recentf.el
index eba1697150f..2f357651dee 100644
--- a/lisp/recentf.el
+++ b/lisp/recentf.el
@@ -102,7 +102,7 @@ You should define the options of your own filters in this group."
102 102
103(defcustom recentf-menu-path '("files") 103(defcustom recentf-menu-path '("files")
104 "*Path where to add the recentf menu. 104 "*Path where to add the recentf menu.
105If nil add it at top-level (see also `easy-menu-change')." 105If nil add it at top level (see also `easy-menu-change')."
106 :group 'recentf 106 :group 'recentf
107 :type '(choice (const :tag "Top Level" nil) 107 :type '(choice (const :tag "Top Level" nil)
108 (sexp :tag "Menu Path")) 108 (sexp :tag "Menu Path"))
@@ -195,15 +195,15 @@ use either \\[customize] or the function `recentf-mode'."
195 :group 'recentf 195 :group 'recentf
196 :type 'hook) 196 :type 'hook)
197 197
198;;; 198;;;;
199;;; Common functions 199;;;; Common functions
200;;; 200;;;;
201(defconst recentf-case-fold-search 201(defconst recentf-case-fold-search
202 (memq system-type '(vax-vms windows-nt)) 202 (memq system-type '(vax-vms windows-nt))
203 "Non-nil if recentf searches and matches should ignore case.") 203 "Non-nil if recentf searches and matches should ignore case.")
204 204
205(defun recentf-include-p (filename) 205(defun recentf-include-p (filename)
206 "Return t if FILENAME matches none of the `recentf-exclude' regexps." 206 "Return t if FILENAME match none of the `recentf-exclude' regexps."
207 (let ((case-fold-search recentf-case-fold-search) 207 (let ((case-fold-search recentf-case-fold-search)
208 (rl recentf-exclude)) 208 (rl recentf-exclude))
209 (while (and rl (not (string-match (car rl) filename))) 209 (while (and rl (not (string-match (car rl) filename)))
@@ -297,7 +297,7 @@ See also `recentf-make-default-menu-element'."
297(defun recentf-apply-menu-filter (filter l) 297(defun recentf-apply-menu-filter (filter l)
298 "Apply function FILTER to the list of menu-elements L. 298 "Apply function FILTER to the list of menu-elements L.
299It takes care of sub-menu elements in L and recursively apply FILTER 299It takes care of sub-menu elements in L and recursively apply FILTER
300to them. It is guarantee than FILTER receives only a list of single 300to them. It is guaranteed that FILTER receives only a list of single
301menu-elements (no sub-menu)." 301menu-elements (no sub-menu)."
302 (if (and (functionp filter) l) 302 (if (and (functionp filter) l)
303 (let ((case-fold-search recentf-case-fold-search) 303 (let ((case-fold-search recentf-case-fold-search)
@@ -366,7 +366,7 @@ filter function this variable is reset to nil.")
366 recentf-menu-items-for-commands))))) 366 recentf-menu-items-for-commands)))))
367 367
368(defun recentf-make-menu-item (menu-element) 368(defun recentf-make-menu-item (menu-element)
369 "Make a menu item from a menu element (see `recentf-make-menu-element')." 369 "Make a menu item from MENU-ELEMENT (see `recentf-make-menu-element')."
370 (let ((menu-item (recentf-menu-element-item menu-element)) 370 (let ((menu-item (recentf-menu-element-item menu-element))
371 (menu-value (recentf-menu-element-value menu-element))) 371 (menu-value (recentf-menu-element-value menu-element)))
372 (if (recentf-sub-menu-element-p menu-element) 372 (if (recentf-sub-menu-element-p menu-element)
@@ -375,9 +375,9 @@ filter function this variable is reset to nil.")
375 (list recentf-menu-action menu-value) 375 (list recentf-menu-action menu-value)
376 t)))) 376 t))))
377 377
378;;; 378;;;;
379;;; Predefined menu filter functions 379;;;; Predefined menu filter functions
380;;; 380;;;;
381 381
382(defun recentf-sort-ascending (l) 382(defun recentf-sort-ascending (l)
383 "Sort the list of menu elements L in ascending order. 383 "Sort the list of menu elements L in ascending order.
@@ -764,9 +764,9 @@ unchanged."
764 t))))) 764 t)))))
765 l)) 765 l))
766 766
767;;; 767;;;;
768;;; Dialogs stuff 768;;;; Dialogs stuff
769;;; 769;;;;
770 770
771(defun recentf-cancel-dialog (&rest ignore) 771(defun recentf-cancel-dialog (&rest ignore)
772 "Cancel the current dialog. 772 "Cancel the current dialog.
@@ -788,16 +788,16 @@ Used by `recentf-edit-list' and `recentf-open-files' dialogs."
788(defun recentf-dialog-mode () 788(defun recentf-dialog-mode ()
789 "Major mode used in recentf dialogs. 789 "Major mode used in recentf dialogs.
790 790
791These are the special commands of recentf-dialog-mode mode: 791These are the special commands of `recentf-dialog-mode' mode:
792 q -- cancel this dialog." 792 q -- cancel this dialog."
793 (interactive) 793 (interactive)
794 (setq major-mode 'recentf-dialog-mode) 794 (setq major-mode 'recentf-dialog-mode)
795 (setq mode-name "recentf-dialog") 795 (setq mode-name "recentf-dialog")
796 (use-local-map recentf-dialog-mode-map)) 796 (use-local-map recentf-dialog-mode-map))
797 797
798;;; 798;;;;
799;;; Hooks and Commands 799;;;; Hooks and Commands
800;;; 800;;;;
801 801
802(defun recentf-add-file-hook () 802(defun recentf-add-file-hook ()
803 "Insert the name of the file just opened or written into `recentf-list'." 803 "Insert the name of the file just opened or written into `recentf-list'."
@@ -858,7 +858,7 @@ is a list (default to the full list)."
858Holds list of files to be deleted from `recentf-list'.") 858Holds list of files to be deleted from `recentf-list'.")
859 859
860(defun recentf-edit-list-action (widget &rest ignore) 860(defun recentf-edit-list-action (widget &rest ignore)
861 "Checkbox widget action used by `recentf-edit-list' to select/unselect a file." 861 "Checkbox WIDGET action used by `recentf-edit-list' to select/unselect a file."
862 (let ((value (widget-get widget ':tag))) 862 (let ((value (widget-get widget ':tag)))
863 ;; if value is already in the selected items 863 ;; if value is already in the selected items
864 (if (memq value recentf-edit-selected-items) 864 (if (memq value recentf-edit-selected-items)
@@ -946,7 +946,7 @@ Holds list of files to be deleted from `recentf-list'.")
946 (setq recentf-update-menu-p t)) 946 (setq recentf-update-menu-p t))
947 947
948(defun recentf-open-files-action (widget &rest ignore) 948(defun recentf-open-files-action (widget &rest ignore)
949 "Button widget action used by `recentf-open-files' to open a file." 949 "Button WIDGET action used by `recentf-open-files' to open a file."
950 (kill-buffer (current-buffer)) 950 (kill-buffer (current-buffer))
951 (funcall recentf-menu-action (widget-value widget))) 951 (funcall recentf-menu-action (widget-value widget)))
952 952
@@ -954,7 +954,7 @@ Holds list of files to be deleted from `recentf-list'.")
954 "String used by `recentf-open-files' to shift right sub-menu items.") 954 "String used by `recentf-open-files' to shift right sub-menu items.")
955 955
956(defun recentf-open-files-item (menu-element) 956(defun recentf-open-files-item (menu-element)
957 "Insert menu-element item in the current interaction buffer." 957 "Insert MENU-ELEMENT item in the current interaction buffer."
958 (let ((menu-item (car menu-element)) 958 (let ((menu-item (car menu-element))
959 (file-path (cdr menu-element))) 959 (file-path (cdr menu-element)))
960 (if (consp file-path) ; This is a sub-menu 960 (if (consp file-path) ; This is a sub-menu
@@ -980,7 +980,7 @@ Holds list of files to be deleted from `recentf-list'.")
980(defun recentf-open-files (&optional files buffer-name) 980(defun recentf-open-files (&optional files buffer-name)
981 "Display buffer allowing user to choose a file from recently-opened list. 981 "Display buffer allowing user to choose a file from recently-opened list.
982The optional argument FILES may be used to specify the list, otherwise 982The optional argument FILES may be used to specify the list, otherwise
983recentf-list is used. The optional argument BUFFER-NAME specifies 983`recentf-list' is used. The optional argument BUFFER-NAME specifies
984which buffer to use for the interaction." 984which buffer to use for the interaction."
985 (interactive) 985 (interactive)
986 (if (null files) 986 (if (null files)
@@ -1057,4 +1057,4 @@ were operated on recently."
1057 1057
1058(run-hooks 'recentf-load-hook) 1058(run-hooks 'recentf-load-hook)
1059 1059
1060;;; recentf.el ends here. 1060;;; recentf.el ends here