Mercurial > emacs
changeset 84657:1b2430509da5
Remove spurious * in docstrings.
(recentf-save-list): Fix up comment style.
| author | Stefan Monnier <monnier@iro.umontreal.ca> |
|---|---|
| date | Wed, 19 Sep 2007 14:53:44 +0000 |
| parents | 3136f19b5c8a |
| children | d1ea5efb14f2 |
| files | lisp/ChangeLog lisp/recentf.el |
| diffstat | 2 files changed, 26 insertions(+), 23 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ChangeLog Wed Sep 19 14:49:27 2007 +0000 +++ b/lisp/ChangeLog Wed Sep 19 14:53:44 2007 +0000 @@ -1,5 +1,8 @@ 2007-09-19 Stefan Monnier <monnier@iro.umontreal.ca> + * recentf.el: Remove spurious * in docstrings. + (recentf-save-list): Fix up comment style. + * progmodes/octave-mod.el: Remove spurious * in docstrings. (octave-mode-map): Move init into declaration and remove \t binding. (octave-mode-startup-message): Remove unused var.
--- a/lisp/recentf.el Wed Sep 19 14:49:27 2007 +0000 +++ b/lisp/recentf.el Wed Sep 19 14:53:44 2007 +0000 @@ -63,14 +63,14 @@ :group 'recentf) (defcustom recentf-max-saved-items 20 - "*Maximum number of items of the recent list that will be saved. + "Maximum number of items of the recent list that will be saved. A nil value means to save the whole list. See the command `recentf-save-list'." :group 'recentf :type 'integer) (defcustom recentf-save-file "~/.recentf" - "*File to save the recent list into." + "File to save the recent list into." :group 'recentf :type 'file :initialize 'custom-initialize-default @@ -91,7 +91,7 @@ integer)) (defcustom recentf-exclude nil - "*List of regexps and predicates for filenames excluded from the recent list. + "List of regexps and predicates for filenames excluded from the recent list. When a filename matches any of the regexps or satisfies any of the predicates it is excluded from the recent list. A predicate is a function that is passed a filename to check and that @@ -109,7 +109,7 @@ (defcustom recentf-keep '(recentf-keep-default-predicate) - "*List of regexps and predicates for filenames kept in the recent list. + "List of regexps and predicates for filenames kept in the recent list. Regexps and predicates are tried in the specified order. When nil all filenames are kept in the recent list. When a filename matches any of the regexps or satisfies any of the @@ -135,13 +135,13 @@ (set-default variable value))) (defcustom recentf-menu-title "Open Recent" - "*Name of the recentf menu." + "Name of the recentf menu." :group 'recentf :type 'string :set 'recentf-menu-customization-changed) (defcustom recentf-menu-path '("File") - "*Path where to add the recentf menu. + "Path where to add the recentf menu. If nil add it at top level (see also `easy-menu-add-item')." :group 'recentf :type '(choice (const :tag "Top Level" nil) @@ -149,7 +149,7 @@ :set 'recentf-menu-customization-changed) (defcustom recentf-menu-before "Open File..." - "*Name of the menu before which the recentf menu will be added. + "Name of the menu before which the recentf menu will be added. If nil add it at end of menu (see also `easy-menu-add-item')." :group 'recentf :type '(choice (string :tag "Name") @@ -157,18 +157,18 @@ :set 'recentf-menu-customization-changed) (defcustom recentf-menu-action 'find-file - "*Function to invoke with a filename item of the recentf menu. + "Function to invoke with a filename item of the recentf menu. The default is to call `find-file' to edit the selected file." :group 'recentf :type 'function) (defcustom recentf-max-menu-items 10 - "*Maximum number of items in the recentf menu." + "Maximum number of items in the recentf menu." :group 'recentf :type 'integer) (defcustom recentf-menu-filter nil - "*Function used to filter files displayed in the recentf menu. + "Function used to filter files displayed in the recentf menu. A nil value means no filter. The following functions are predefined: - `recentf-sort-ascending' @@ -222,13 +222,13 @@ function)) (defcustom recentf-menu-open-all-flag nil - "*Non-nil means to show an \"All...\" item in the menu. + "Non-nil means to show an \"All...\" item in the menu. This item will replace the \"More...\" item." :group 'recentf :type 'boolean) (defcustom recentf-menu-append-commands-flag t - "*Non-nil means to append command items to the menu." + "Non-nil means to append command items to the menu." :group 'recentf :type 'boolean) @@ -237,7 +237,7 @@ "22.1") (defcustom recentf-auto-cleanup 'mode - "*Define when to automatically cleanup the recent list. + "Define when to automatically cleanup the recent list. The following values can be set: - `mode' @@ -270,13 +270,13 @@ (recentf-auto-cleanup)))) (defcustom recentf-initialize-file-name-history t - "*Non-nil means to initialize `file-name-history' with the recent list. + "Non-nil means to initialize `file-name-history' with the recent list. If `file-name-history' is not empty, do nothing." :group 'recentf :type 'boolean) (defcustom recentf-load-hook nil - "*Normal hook run at end of loading the `recentf' package." + "Normal hook run at end of loading the `recentf' package." :group 'recentf :type 'hook) @@ -777,7 +777,7 @@ ("Java files (%d)" ".\\.java\\'") ("C/C++ files (%d)" "c\\(pp\\)?\\'") ) - "*List of rules used by `recentf-arrange-by-rule' to build sub-menus. + "List of rules used by `recentf-arrange-by-rule' to build sub-menus. A rule is a pair (SUB-MENU-TITLE . MATCHER). SUB-MENU-TITLE is the displayed title of the sub-menu where a '%d' `format' pattern is replaced by the number of items in the sub-menu. MATCHER is a regexp @@ -793,7 +793,7 @@ (repeat regexp)))) (defcustom recentf-arrange-by-rule-others "Other files (%d)" - "*Title of the `recentf-arrange-by-rule' sub-menu. + "Title of the `recentf-arrange-by-rule' sub-menu. This is for the menu where items that don't match any `recentf-arrange-rules' are displayed. If nil these items are displayed in the main recent files menu. A '%d' `format' pattern in @@ -803,7 +803,7 @@ (string :tag "Title"))) (defcustom recentf-arrange-by-rules-min-items 0 - "*Minimum number of items in a `recentf-arrange-by-rule' sub-menu. + "Minimum number of items in a `recentf-arrange-by-rule' sub-menu. If the number of items in a sub-menu is less than this value the corresponding sub-menu items are displayed in the main recent files menu or in the `recentf-arrange-by-rule-others' sub-menu if @@ -812,7 +812,7 @@ :type 'number) (defcustom recentf-arrange-by-rule-subfilter nil - "*Function called by a rule based filter to filter sub-menu elements. + "Function called by a rule based filter to filter sub-menu elements. A nil value means no filter. See also `recentf-menu-filter'. You can't use another rule based filter here." :group 'recentf-filters @@ -966,7 +966,7 @@ (recentf-arrange-by-dir . "Grouped by Directory") (recentf-arrange-by-rule . "Grouped by Custom Rules") ) - "*List of filters managed by `recentf-filter-changer'. + "List of filters managed by `recentf-filter-changer'. Each filter is defined by a pair (FUNCTION . LABEL), where FUNCTION is the filter function, and LABEL is the menu item displayed to select that filter." @@ -1280,9 +1280,9 @@ (insert (format recentf-save-file-header (current-time-string))) (recentf-dump-variable 'recentf-list recentf-max-saved-items) (recentf-dump-variable 'recentf-filter-changer-current) - (insert "\n \n;;; Local Variables:\n" - (format ";;; coding: %s\n" recentf-save-file-coding-system) - ";;; End:\n") + (insert "\n \n;; Local Variables:\n" + (format ";; coding: %s\n" recentf-save-file-coding-system) + ";; End:\n") (write-file (expand-file-name recentf-save-file)) (when recentf-save-file-modes (set-file-modes recentf-save-file recentf-save-file-modes))