+2008-10-25 Juanma Barranquero <lekktu@gmail.com>
+
+ * completion.el (add-completion-to-head, add-completion): Doc fixes.
+ (completion-search-next, add-completions-from-file):
+ Fix typos in docstrings.
+
+ * filesets.el (filesets-menu-ensure-use-cached)
+ (filesets-ingroup-patterns, filesets-filetype-property):
+ * tutorial.el (get-lang-string):
+ * play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
+ Fix typos in docstrings.
+
+ * image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
+ (image-dired-line-up-method, image-dired-thumb-size)
+ (image-dired-cmd-write-exif-data-options, image-dired-write-tags)
+ (image-dired-track-original-file, image-dired-track-thumbnail)
+ (image-dired-dired-next-line, image-dired-dired-previous-line)
+ (image-dired-write-comments): Reflow docstrings.
+ (image-dired-show-all-from-dir-max-files)
+ (image-dired-format-properties-string, image-dired-create-thumbs)
+ (image-dired-mark-tagged-files, image-dired-gallery-generate):
+ Fix typos in docstrings.
+
+ * savehist.el (savehist-save-minibuffer-history, savehist-file)
+ (savehist-additional-variables, savehist-ignored-variables)
+ (savehist-file-modes, savehist-autosave-interval):
+ * startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
+ (inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
+ (fancy-splash-image):
+ * thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
+ (thumbs-conversion-program, thumbs-margin):
+ Remove spurious * in docstrings.
+
2008-10-25 Aaron S. Hawley <aaronh@garden.org>
* thingatpt.el (end-of-sexp, beginning-of-sexp)
(defun add-completion-to-head (completion-string)
"If COMPLETION-STRING is not in the database, add it to prefix list.
We add COMPLETION-STRING to the head of the appropriate prefix list,
-or it to the head of the list.
+or to the head of the list.
COMPLETION-STRING must be longer than `completion-prefix-min-length'.
Updates the saved string with the supplied string.
This must be very fast.
(defun add-completion (string &optional num-uses last-use-time)
"Add STRING to completion list, or move it to head of list.
-The completion is altered appropriately if num-uses and/or last-use-time is
-specified."
+The completion is altered appropriately if NUM-USES and/or LAST-USE-TIME
+are specified."
(interactive (interactive-completion-string-reader "Completion to add"))
(check-completion-length string)
(let* ((current-completion-source (if (interactive-p)
(defun completion-search-next (index)
"Return the next completion entry.
If INDEX is out of sequence, reset and start from the top.
-If there are no more entries, try cdabbrev and returns only a string."
+If there are no more entries, try cdabbrev and return only a string."
(cond
((= index (setq cmpl-last-index (1+ cmpl-last-index)))
(completion-search-peek t))
;; User interface
(defun add-completions-from-file (file)
- "Parse possible completions from a FILE and add them to data base."
+ "Parse possible completions from a FILE and add them to database."
(interactive "fFile: ")
(setq file (expand-file-name file))
(let* ((buffer (get-file-buffer file))
So, when should you think about setting this value to t? If filesets.el
is loaded before user customizations. Thus, if (require 'filesets)
-precedes the custom-set-variables command or, for XEmacs, if init.el is
-loaded before custom.el, set this variable to t.")
+precedes the `custom-set-variables' command or, for XEmacs, if init.el
+is loaded before custom.el, set this variable to t.")
;;; utils
in the pattern holding the subfile's name. 0 refers the whole
match, 1 to the first group.
-:stubp FUNCTION ... if (FUNCTION MASTER INCLUDED-FILE) returns non-nil,
+:stubp FUNCTION ... If (FUNCTION MASTER INCLUDED-FILE) returns non-nil,
INCLUDED-FILE is a stub -- see below.
-:stub-flag ... files of this type are stubs -- see below.
+:stub-flag ... Files of this type are stubs -- see below.
:scan-depth INTEGER (default: 0) ... Whether included files should be
rescanned. Set this to 0 to disable re-scanning of included file.
on-capture-output (:capture-output) ... Capture output of an external viewer
-on-ls ... not used
+on-ls ... Not used
-on-cmd ... not used
+on-cmd ... Not used
-on-close-all ... not used"
+on-close-all ... Not used"
(let ((def (filesets-eviewer-get-props
(or entry
(filesets-get-external-viewer filename)))))
"%p -%t=\"%v\" \"%f\""
"Format of command used to write EXIF data.
Available options are %p which is replaced by
-`image-dired-cmd-write-exif-data-program', %f which is replaced by the
-image file name, %t which is replaced by the tag name and %v
+`image-dired-cmd-write-exif-data-program', %f which is replaced by
+the image file name, %t which is replaced by the tag name and %v
which is replaced by the tag value."
:type 'string
:group 'image-dired)
(defcustom image-dired-thumb-size (if (eq 'standard image-dired-thumbnail-storage) 128 100)
"Size of thumbnails, in pixels.
-This is the default size for both `image-dired-thumb-width' and `image-dired-thumb-height'."
+This is the default size for both `image-dired-thumb-width'
+and `image-dired-thumb-height'."
:type 'integer
:group 'image-dired)
(defcustom image-dired-line-up-method 'dynamic
"Default method for line-up of thumbnails in thumbnail buffer.
-Used by `image-dired-display-thumbs' and other functions that needs to
-line-up thumbnails. Dynamic means to use the available width of the
-window containing the thumbnail buffer, Fixed means to use
-`image-dired-thumbs-per-row', Interactive is for asking the user, and No
-line-up means that no automatic line-up will be done."
+Used by `image-dired-display-thumbs' and other functions that needs
+to line-up thumbnails. Dynamic means to use the available width of
+the window containing the thumbnail buffer, Fixed means to use
+`image-dired-thumbs-per-row', Interactive is for asking the user,
+and No line-up means that no automatic line-up will be done."
:type '(choice :tag "Default line-up method"
(const :tag "Dynamic" dynamic)
(const :tag "Fixed" fixed)
:group 'image-dired)
(defcustom image-dired-show-all-from-dir-max-files 50
- "Maximum number of files to show using `image-dired-show-all-from-dir'.
+ "Maximum number of files to show using `image-dired-show-all-from-dir'
before warning the user."
:type 'integer
:group 'image-dired)
(defun image-dired-dired-after-readin-hook ()
"Relocate existing thumbnail overlays in dired buffer after reverting.
-Move them to their corresponding files if they are still exist.
+Move them to their corresponding files if they still exist.
Otherwise, delete overlays."
(mapc (lambda (overlay)
(when (overlay-get overlay 'put-image)
(defun image-dired-write-tags (file-tags)
"Write file tags to database.
-Write each file and tag in FILE-TAGS to the database. FILE-TAGS
-is an alist in the following form:
+Write each file and tag in FILE-TAGS to the database.
+FILE-TAGS is an alist in the following form:
((FILE . TAG) ... )"
(image-dired-sane-db-file)
(let (end file tag)
(defun image-dired-track-original-file ()
"Track the original file in the associated dired buffer.
-See documentation for `image-dired-toggle-movement-tracking'. Interactive
-use only useful if `image-dired-track-movement' is nil."
+See documentation for `image-dired-toggle-movement-tracking'.
+Interactive use only useful if `image-dired-track-movement' is nil."
(interactive)
(let ((old-buf (current-buffer))
(dired-buf (image-dired-associated-dired-buffer))
(defun image-dired-track-thumbnail ()
"Track current dired file's thumb in `image-dired-thumbnail-buffer'.
-This is almost the same as what `image-dired-track-original-file' does, but
-the other way around."
+This is almost the same as what `image-dired-track-original-file' does,
+but the other way around."
(let ((file (dired-get-filename))
(old-buf (current-buffer))
prop-val found)
(defun image-dired-dired-next-line (&optional arg)
"Call `dired-next-line', then track thumbnail.
-This can safely replace `dired-next-line'. With prefix argument, move
-ARG lines."
+This can safely replace `dired-next-line'.
+With prefix argument, move ARG lines."
(interactive "P")
(dired-next-line (or arg 1))
(if image-dired-track-movement
(defun image-dired-dired-previous-line (&optional arg)
"Call `dired-previous-line', then track thumbnail.
-This can safely replace `dired-previous-line'. With prefix argument,
-move ARG lines."
+This can safely replace `dired-previous-line'.
+With prefix argument, move ARG lines."
(interactive "P")
(dired-previous-line (or arg 1))
(if image-dired-track-movement
(defun image-dired-format-properties-string (buf file props comment)
"Format display properties.
BUF is the associated dired buffer, FILE is the original image file
-name, PROPS is a list of tags and COMMENT is the image files's
+name, PROPS is a list of tags and COMMENT is the image file's
comment."
(format-spec
image-dired-display-properties-format
(defun image-dired-create-thumbs (&optional arg)
"Create thumbnail images for all marked files in dired.
With prefix argument ARG, create thumbnails even if they already exist
-\(i.e. use this to refresh your thumbnails)."
+\(i.e. use this to refresh your thumbnails)."
(interactive "P")
(let (curr-file thumb-name files count)
(setq files (dired-get-marked-files))
(defun image-dired-write-comments (file-comments)
"Write file comments to database.
-Write file comments to one or more files. FILE-COMMENTS is an alist on
-the following form:
+Write file comments to one or more files.
+FILE-COMMENTS is an alist on the following form:
((FILE . COMMENT) ... )"
(image-dired-sane-db-file)
(let (end comment-beg-pos comment-end-pos file comment)
image file and stored in image-dired's database file. This command
lets you input a regexp and this will be matched against all tags
on all image files in the database file. The files that have a
-matching tags will be marked in the dired buffer."
+matching tag will be marked in the dired buffer."
(interactive)
(image-dired-sane-db-file)
(let ((tag (read-string "Mark tagged files (regexp): "))
"Generate gallery pages.
First we create a couple of Lisp structures from the database to make
it easier to generate, then HTML-files are created in
-`image-dired-gallery-dir'"
+`image-dired-gallery-dir'."
(interactive)
(if (eq 'per-directory image-dired-thumbnail-storage)
(error "Currently, gallery generation is not supported \
(defvar gamegrid-buffer-start 1)
(defvar gamegrid-score-file-length 50
- "Number of high scores to keep")
+ "Number of high scores to keep.")
(defvar gamegrid-user-score-file-directory
(locate-user-emacs-file "games/")
"Add the current score to the high score file.
On POSIX systems there may be a shared game directory for all users in
-which the scorefiles are kept. On such systems Emacs doesn't create
-the score file FILE in this directory, if it doesn't already exist. In
-this case Emacs searches for FILE in the directory specified by
+which the scorefiles are kept. On such systems Emacs doesn't create
+the score file FILE in this directory, if it doesn't already exist.
+In this case Emacs searches for FILE in the directory specified by
`gamegrid-user-score-file-directory' and creates it there, if
necessary.
To add the score file for a game to the system wide shared game
directory, create the file with the shell command \"touch\" in this
directory and make sure that it is owned by the correct user and
-group. You probably need special user privileges to do this.
+group. You probably need special user privileges to do this.
On non-POSIX systems Emacs searches for FILE in the directory
-specified by the variable `temporary-file-directory'. If necessary,
+specified by the variable `temporary-file-directory'. If necessary,
FILE is created there."
(case system-type
((ms-dos windows-nt)
:group 'savehist)
(defcustom savehist-save-minibuffer-history t
- "*If non-nil, save all recorded minibuffer histories.
+ "If non-nil, save all recorded minibuffer histories.
If you want to save only specific histories, use `savehist-save-hook' to
modify the value of `savehist-minibuffer-history-variables'."
:type 'boolean
:group 'savehist)
(defcustom savehist-additional-variables ()
- "*List of additional variables to save.
+ "List of additional variables to save.
Each element is a symbol whose value will be persisted across Emacs
sessions that use savehist. The contents of variables should be
printable with the Lisp printer. You don't need to add minibuffer
:group 'savehist)
(defcustom savehist-ignored-variables nil ;; '(command-history)
- "*List of additional variables not to save."
+ "List of additional variables not to save."
:type '(repeat variable)
:group 'savehist)
(defcustom savehist-file
(locate-user-emacs-file "history" ".emacs-history")
- "*File name where minibuffer history is saved to and loaded from.
+ "File name where minibuffer history is saved to and loaded from.
The minibuffer history is a series of Lisp expressions loaded
automatically when `savehist-mode' is turned on. See `savehist-mode'
for more details.
:group 'savehist)
(defcustom savehist-file-modes #o600
- "*Default permissions of the history file.
+ "Default permissions of the history file.
This is decimal, not octal. The default is 384 (0600 in octal).
Set to nil to use the default permissions that Emacs uses, typically
mandated by umask. The default is a bit more restrictive to protect
:group 'savehist)
(defcustom savehist-autosave-interval (* 5 60)
- "*The interval between autosaves of minibuffer history.
+ "The interval between autosaves of minibuffer history.
If set to nil, disables timer-based autosaving."
:type 'integer
:group 'savehist)
(defvar startup-screen-inhibit-startup-screen nil)
(defcustom inhibit-startup-echo-area-message nil
- "*Non-nil inhibits the initial startup echo area message.
+ "Non-nil inhibits the initial startup echo area message.
Setting this variable takes effect
only if you do it with the customization buffer
or if your `.emacs' file contains a line of this form:
:group 'initialization)
(defcustom inhibit-default-init nil
- "*Non-nil inhibits loading the `default' library."
+ "Non-nil inhibits loading the `default' library."
:type 'boolean
:group 'initialization)
(defcustom inhibit-startup-buffer-menu nil
- "*Non-nil inhibits display of buffer list when more than 2 files are loaded."
+ "Non-nil inhibits display of buffer list when more than 2 files are loaded."
:type 'boolean
:group 'initialization)
(error "Customizing `site-run-file' does not work")))
(defcustom mail-host-address nil
- "*Name of this machine, for purposes of naming users."
+ "Name of this machine, for purposes of naming users."
:type '(choice (const nil) string)
:group 'mail)
(system-name))))
;; Empty string means "not set yet".
"")
- "*Full mailing address of this user.
+ "Full mailing address of this user.
This is initialized with environment variable `EMAIL' or, as a
fallback, using `mail-host-address'. This is done after your
init file is read, in case it sets `mail-host-address'."
:group 'initialization)
(defcustom fancy-splash-image nil
- "*The image to show in the splash screens, or nil for defaults."
+ "The image to show in the splash screens, or nil for defaults."
:group 'fancy-splash-screen
:type '(choice (const :tag "Default" nil)
(file :tag "File")))
:group 'multimedia)
(defcustom thumbs-thumbsdir (locate-user-emacs-file "thumbs")
- "*Directory to store thumbnails."
+ "Directory to store thumbnails."
:type 'directory
:group 'thumbs)
(defcustom thumbs-geometry "100x100"
- "*Size of thumbnails."
+ "Size of thumbnails."
:type 'string
:group 'thumbs)
"convert.exe"
(or (executable-find "convert")
"/usr/X11R6/bin/convert"))
- "*Name of conversion program for thumbnails generation.
+ "Name of conversion program for thumbnails generation.
It must be 'convert'."
:type 'string
:group 'thumbs)
:group 'thumbs)
(defcustom thumbs-relief 5
- "*Size of button-like border around thumbnails."
+ "Size of button-like border around thumbnails."
:type 'integer
:group 'thumbs)
(defcustom thumbs-margin 2
- "*Size of the margin around thumbnails.
+ "Size of the margin around thumbnails.
This is where you see the cursor."
:type 'integer
:group 'thumbs)
In certain places Emacs can replace a string shown to the user with
a language specific string. This function retrieves such strings.
-LANG is the language specification. It should be one of those
+LANG is the language specification. It should be one of those
strings that can be returned by `read-language-name'. STRINGID
is a symbol that specifies the string to retrieve.
projects / emacs.git / commitdiff