diff options
Diffstat (limited to 'lisp/progmodes')
45 files changed, 271 insertions, 270 deletions
diff --git a/lisp/progmodes/cc-align.el b/lisp/progmodes/cc-align.el index 9234d0b19b9..a26c1d5bff9 100644 --- a/lisp/progmodes/cc-align.el +++ b/lisp/progmodes/cc-align.el @@ -914,7 +914,7 @@ Works with: template-args-cont." (defun c-lineup-ObjC-method-call (langelem) "Line up selector args as Emacs Lisp mode does with function args: Go to the position right after the message receiver, and if you are at -the end of the line, indent the current line c-basic-offset columns +the end of the line, indent the current line `c-basic-offset' columns from the opening bracket; otherwise you are looking at the first character of the first method call argument, so line up the current line with it. @@ -943,9 +943,9 @@ Works with: objc-method-call-cont." (defun c-lineup-ObjC-method-call-colons (langelem) "Line up selector args as Project Builder / XCode: colons of first - selector portions on successive lines are aligned. If no decision can - be made return NIL, so that other lineup methods can be tried. This is - typically chained with `c-lineup-ObjC-method-call'. +selector portions on successive lines are aligned. If no decision can +be made return NIL, so that other lineup methods can be tried. This is +typically chained with `c-lineup-ObjC-method-call'. Works with: objc-method-call-cont." (save-excursion diff --git a/lisp/progmodes/cc-awk.el b/lisp/progmodes/cc-awk.el index f1bc25db7f7..ea991017508 100644 --- a/lisp/progmodes/cc-awk.el +++ b/lisp/progmodes/cc-awk.el @@ -1095,9 +1095,10 @@ std\\(err\\|in\\|out\\)\\|user\\)\\)\\>\ "[#\n\r]")))))))) (defun c-awk-beginning-of-defun (&optional arg) - "Move backward to the beginning of an AWK \"defun\". With ARG, do it that -many times. Negative arg -N means move forward to Nth following beginning of -defun. Returns t unless search stops due to beginning or end of buffer. + "Move backward to the beginning of an AWK \"defun\". +With ARG, do it that many times. Negative arg -N means move +forward to Nth following beginning of defun. Returns t unless +search stops due to beginning or end of buffer. By a \"defun\" is meant either a pattern-action pair or a function. The start of a defun is recognized as code starting at column zero which is neither a diff --git a/lisp/progmodes/cc-bytecomp.el b/lisp/progmodes/cc-bytecomp.el index edbac64eadb..f07f18678a2 100644 --- a/lisp/progmodes/cc-bytecomp.el +++ b/lisp/progmodes/cc-bytecomp.el @@ -381,7 +381,7 @@ afterwards. Don't use within `eval-when-compile'." (eval-when-compile (cc-bytecomp-setup-environment)))) (defmacro cc-bytecomp-defvar (var) - "Binds the symbol as a variable during compilation of the file, + "Bind the symbol as a variable during compilation of the file, to silence the byte compiler. Don't use within `eval-when-compile'." (declare (debug nil)) `(eval-when-compile diff --git a/lisp/progmodes/cc-cmds.el b/lisp/progmodes/cc-cmds.el index bdfdf178d43..217281b8a24 100644 --- a/lisp/progmodes/cc-cmds.el +++ b/lisp/progmodes/cc-cmds.el @@ -497,7 +497,7 @@ function to control that." (defvar c--unsafe-post-self-insert-hook-functions '(electric-pair-post-self-insert-function) - "Known unsafe functions when members of `post-self-insert-hook' in CC Mode") + "Known unsafe functions when members of `post-self-insert-hook' in CC Mode.") (defun c--call-post-self-insert-hook-more-safely-1 () ;; Call post-self-insert-hook, having removed from `post-self-insert-hook' @@ -2059,7 +2059,7 @@ the open-parenthesis that starts a defun; see `beginning-of-defun'." (defun c-defun-name-1 () "Return the name of the current defun, at the current narrowing, -or NIL if there isn't one. \"Defun\" here means a function, or +or nil if there isn't one. \"Defun\" here means a function, or other top level construct with a brace block." (c-save-buffer-state (beginning-of-defun-function end-of-defun-function @@ -3383,12 +3383,12 @@ directives." (defun c-backward-conditional (count &optional target-depth with-else) "Move back across a preprocessor conditional, leaving mark behind. -A prefix argument acts as a repeat count. With a negative argument, +A prefix argument acts as a repeat COUNT. With a negative argument, move forward across a preprocessor conditional. The optional arguments TARGET-DEPTH and WITH-ELSE are historical, and have the same meanings as in `c-scan-conditionals'. If you -are calling c-forward-conditional from a program, you might want +are calling `c-forward-conditional' from a program, you might want to call `c-scan-conditionals' directly instead." (interactive "p") (let ((new-point (c-scan-conditionals (- count) target-depth with-else))) diff --git a/lisp/progmodes/cc-defs.el b/lisp/progmodes/cc-defs.el index fe6ff220baf..be0b40fd6c2 100644 --- a/lisp/progmodes/cc-defs.el +++ b/lisp/progmodes/cc-defs.el @@ -1385,7 +1385,7 @@ point is then left undefined." "Remove all text-properties PROPERTY from the region (FROM, TO) which have the value VALUE, as tested by `equal'. These properties are assumed to be over individual characters, having -been put there by c-put-char-property. POINT remains unchanged." +been put there by `c-put-char-property'. POINT remains unchanged." (let ((place from) end-place) (while ; loop round occurrences of (PROPERTY VALUE) (progn @@ -1406,7 +1406,7 @@ been put there by c-put-char-property. POINT remains unchanged." "Remove all text-properties PROPERTY from the region [FROM, TO) which have the value VALUE, as tested by `equal'. These properties are assumed to be over individual characters, having -been put there by c-put-char-property. POINT remains unchanged." +been put there by `c-put-char-property'. POINT remains unchanged." (declare (debug t)) (if c-use-extents ;; XEmacs diff --git a/lisp/progmodes/cc-engine.el b/lisp/progmodes/cc-engine.el index 77da98f6262..53c382f018c 100644 --- a/lisp/progmodes/cc-engine.el +++ b/lisp/progmodes/cc-engine.el @@ -1731,7 +1731,7 @@ Line continuations, i.e. a backslashes followed by line breaks, are treated as whitespace. The line breaks that end line comments are considered to be the comment enders, so the point cannot be at the end of the same line to move over a line comment. Unlike -c-backward-syntactic-ws, this function doesn't move back over +`c-backward-syntactic-ws', this function doesn't move back over preprocessor directives. Note that this function might do hidden buffer changes. See the @@ -3210,7 +3210,7 @@ comment at the start of cc-engine.el for more info." This function should be added to the `before-change-functions' hook by major modes that use CC Mode's filling functionality without initializing CC Mode. Currently (2020-06) these are -js-mode and mhtml-mode." +`js-mode' and `mhtml-mode'." (c-truncate-lit-pos-cache beg)) (defun c-foreign-init-lit-pos-cache () @@ -3218,8 +3218,8 @@ js-mode and mhtml-mode." This function should be called from the mode functions of major modes which use CC Mode's filling functionality without -initializing CC Mode. Currently (2020-06) these are js-mode and -mhtml-mode." +initializing CC Mode. Currently (2020-06) these are `js-mode' and +`mhtml-mode'." (c-truncate-lit-pos-cache 1)) @@ -7223,7 +7223,7 @@ comment at the start of cc-engine.el for more info." ;; the rest of the file is fontified normally. (defun c-ml-string-make-closer-re (_opener) - "Return c-ml-string-any-closer-re. + "Return `c-ml-string-any-closer-re'. This is a suitable language specific value of `c-make-ml-string-closer-re-function' for most languages with @@ -7231,7 +7231,7 @@ multi-line strings (but not C++, for example)." c-ml-string-any-closer-re) (defun c-ml-string-make-opener-re (_closer) - "Return c-ml-string-opener-re. + "Return `c-ml-string-opener-re'. This is a suitable language specific value of `c-make-ml-string-opener-re-function' for most languages with diff --git a/lisp/progmodes/cc-guess.el b/lisp/progmodes/cc-guess.el index 9c88c14a6c1..8f46b17c54d 100644 --- a/lisp/progmodes/cc-guess.el +++ b/lisp/progmodes/cc-guess.el @@ -34,18 +34,18 @@ ;; are some variants. ;; ;; Suppose the major mode for the current buffer is one of the modes -;; provided by cc-mode. `c-guess' guesses the indentation style by +;; provided by cc-mode. `c-guess' guesses the indentation style by ;; examining the indentation in the region between beginning of buffer ;; and `c-guess-region-max'. -;; and installs the guessed style. The name for installed style is given +;; and installs the guessed style. The name for installed style is given ;; by `c-guess-style-name'. ;; ;; `c-guess-buffer' does the same but in the whole buffer. ;; `c-guess-region' does the same but in the region between the point ;; and the mark. `c-guess-no-install', `c-guess-buffer-no-install' ;; and `c-guess-region-no-install' guess the indentation style but -;; don't install it. You can review a guessed style with `c-guess-view'. +;; don't install it. You can review a guessed style with `c-guess-view'. ;; After reviewing, use `c-guess-install' to install the style ;; if you prefer it. ;; @@ -56,11 +56,11 @@ ;; or implicitly with `c-guess', `c-guess-buffer', or `c-guess-region', ;; a style name is given by `c-guess-style-name' with the above form. ;; -;; If you want to reuse the guessed style in future emacs sessions, -;; you may want to put it to your .emacs. `c-guess-view' is for -;; you. It emits Emacs Lisp code which defines the last guessed -;; style, in a temporary buffer. You can put the emitted code into -;; your .emacs. This command was suggested by Alan Mackenzie. +;; If you want to reuse the guessed style in future Emacs sessions, +;; you may want to put it to your .emacs. `c-guess-view' is for +;; you. It emits Emacs Lisp code which defines the last guessed +;; style, in a temporary buffer. You can put the emitted code into +;; your .emacs. This command was suggested by Alan Mackenzie. ;;; Code: @@ -91,7 +91,7 @@ The offset of a line included in the indent information returned by (defcustom c-guess-region-max 50000 "The maximum region size for examining indent information with `c-guess'. It takes a long time to examine indent information from a large region; -this option helps you limit that time. nil means no limit." +this option helps you limit that time. nil means no limit." :version "24.1" :type 'integer :group 'c) @@ -465,7 +465,7 @@ the absolute file name of the file if STYLE-NAME is nil." (defun c-guess-dump-guessed-style (&optional printer) "Show the guessed style. `pp' is used to print the style but if PRINTER is given, -PRINTER is used instead. If PRINTER is not nil, it +PRINTER is used instead. If PRINTER is not nil, it is called with one argument, the guessed style." (interactive) (let ((style (c-guess-make-style c-guess-guessed-basic-offset diff --git a/lisp/progmodes/cc-langs.el b/lisp/progmodes/cc-langs.el index 0b125bc43fa..b106454b11e 100644 --- a/lisp/progmodes/cc-langs.el +++ b/lisp/progmodes/cc-langs.el @@ -151,10 +151,10 @@ c-emacs-variable-inits-tail c-emacs-variable-inits)) (defmacro c-lang-defvar (var val &optional doc) - "Declares the buffer local variable VAR to get the value VAL. VAL is -evaluated and assigned at mode initialization. More precisely, VAL is -evaluated and bound to VAR when the result from the macro -`c-init-language-vars' is evaluated. + "Declares the buffer local variable VAR to get the value VAL. +VAL is evaluated and assigned at mode initialization. More +precisely, VAL is evaluated and bound to VAR when the result from +the macro `c-init-language-vars' is evaluated. `c-lang-const' is typically used in VAL to get the right value for the language being initialized, and such calls will be macro expanded to @@ -184,8 +184,8 @@ the evaluated constant value at compile time." `',var) (defmacro c-lang-setvar (var val) - "Causes the variable VAR to be made buffer local and to get set to the -value VAL. VAL is evaluated and assigned at mode initialization. More + "Make variable VAR buffer local and set it to value VAL. +VAL is evaluated and assigned at mode initialization. More precisely, VAL is evaluated and bound to VAR when the result from the macro `c-init-language-vars' is evaluated. VAR is typically a standard Emacs variable like `comment-start'. diff --git a/lisp/progmodes/cc-menus.el b/lisp/progmodes/cc-menus.el index a099ec1de95..52b47a58732 100644 --- a/lisp/progmodes/cc-menus.el +++ b/lisp/progmodes/cc-menus.el @@ -172,7 +172,7 @@ A sample value might look like: `\\(_P\\|_PROTO\\)'.") "[ \t\n\r]*")) (defun cc-imenu-java-build-type-args-regex (depth) - "Builds regexp for type arguments list with DEPTH allowed + "Build regexp for type arguments list with DEPTH allowed nested angle brackets constructs." (if (> depth 0) (concat "<" diff --git a/lisp/progmodes/cc-mode.el b/lisp/progmodes/cc-mode.el index 057d292246f..c818c1a3582 100644 --- a/lisp/progmodes/cc-mode.el +++ b/lisp/progmodes/cc-mode.el @@ -575,9 +575,8 @@ preferably use the `c-mode-menu' language constant directly." (make-variable-buffer-local 'c-max-syn-tab-mkr) (defun c-basic-common-init (mode default-style) - "Do the necessary initialization for the syntax handling routines -and the line breaking/filling code. Intended to be used by other -packages that embed CC Mode. + "Initialize the syntax handling routines and the line breaking/filling code. +Intended to be used by other packages that embed CC Mode. MODE is the CC Mode flavor to set up, e.g. `c-mode' or `java-mode'. DEFAULT-STYLE tells which indentation style to install. It has the @@ -2568,17 +2567,17 @@ opening \" and the next unescaped end of line." (defvar c-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table c)) - "Syntax table used in c-mode buffers.") + "Syntax table used in `c-mode' buffers.") (defvar c-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in c-mode buffers.") + "Keymap used in `c-mode' buffers.") ;; Add bindings which are only useful for C. (define-key c-mode-map "\C-c\C-e" 'c-macro-expand) -(easy-menu-define c-c-menu c-mode-map "C Mode Commands" +(easy-menu-define c-c-menu c-mode-map "C Mode Commands." (cons "C" (c-lang-const c-mode-menu c))) ;; In XEmacs >= 21.5 modes should add their own entries to @@ -2617,7 +2616,7 @@ opening \" and the next unescaped end of line." "Major mode for editing C code. To submit a problem report, enter `\\[c-submit-bug-report]' from a -c-mode buffer. This automatically sets up a mail buffer with version +`c-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2701,7 +2700,7 @@ the code is C or C++ and based on that chooses whether to enable (define-key c++-mode-map "<" 'c-electric-lt-gt) (define-key c++-mode-map ">" 'c-electric-lt-gt) -(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands" +(easy-menu-define c-c++-menu c++-mode-map "C++ Mode Commands." (cons "C++" (c-lang-const c-mode-menu c++))) ;;;###autoload @@ -2738,16 +2737,16 @@ Key bindings: (defvar objc-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table objc)) - "Syntax table used in objc-mode buffers.") + "Syntax table used in `objc-mode' buffers.") (defvar objc-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in objc-mode buffers.") + "Keymap used in `objc-mode' buffers.") ;; Add bindings which are only useful for Objective-C. (define-key objc-mode-map "\C-c\C-e" 'c-macro-expand) -(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands" +(easy-menu-define c-objc-menu objc-mode-map "ObjC Mode Commands." (cons "ObjC" (c-lang-const c-mode-menu objc))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.m\\'" . objc-mode)) @@ -2756,7 +2755,7 @@ Key bindings: (define-derived-mode objc-mode prog-mode "ObjC" "Major mode for editing Objective C code. To submit a problem report, enter `\\[c-submit-bug-report]' from an -objc-mode buffer. This automatically sets up a mail buffer with +`objc-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2785,12 +2784,12 @@ Key bindings: (defvar java-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table java)) - "Syntax table used in java-mode buffers.") + "Syntax table used in `java-mode' buffers.") (defvar java-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in java-mode buffers.") + "Keymap used in `java-mode' buffers.") ;; Add bindings which are only useful for Java. ;; Regexp trying to describe the beginning of a Java top-level @@ -2800,7 +2799,7 @@ Key bindings: (defconst c-Java-defun-prompt-regexp "^[ \t]*\\(\\(\\(public\\|protected\\|private\\|const\\|abstract\\|synchronized\\|final\\|static\\|threadsafe\\|transient\\|native\\|volatile\\)\\s-+\\)*\\(\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]+\\|[[a-zA-Z]\\)\\s-*\\)\\s-+\\)\\)?\\(\\([[a-zA-Z][][_$.a-zA-Z0-9]*\\s-+\\)\\s-*\\)?\\([_a-zA-Z][^][ \t:;.,{}()\^?=]*\\|\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)\\)\\s-*\\(([^);{}]*)\\)?\\([] \t]*\\)\\(\\s-*\\<throws\\>\\s-*\\(\\([_$a-zA-Z][_$.a-zA-Z0-9]*\\)[, \t\n\r\f\v]*\\)+\\)?\\s-*") -(easy-menu-define c-java-menu java-mode-map "Java Mode Commands" +(easy-menu-define c-java-menu java-mode-map "Java Mode Commands." (cons "Java" (c-lang-const c-mode-menu java))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.java\\'" . java-mode)) @@ -2809,7 +2808,7 @@ Key bindings: (define-derived-mode java-mode prog-mode "Java" "Major mode for editing Java code. To submit a problem report, enter `\\[c-submit-bug-report]' from a -java-mode buffer. This automatically sets up a mail buffer with +`java-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2836,15 +2835,15 @@ Key bindings: (defvar idl-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table idl)) - "Syntax table used in idl-mode buffers.") + "Syntax table used in `idl-mode' buffers.") (defvar idl-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in idl-mode buffers.") + "Keymap used in `idl-mode' buffers.") ;; Add bindings which are only useful for IDL. -(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands" +(easy-menu-define c-idl-menu idl-mode-map "IDL Mode Commands." (cons "IDL" (c-lang-const c-mode-menu idl))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.idl\\'" . idl-mode)) @@ -2853,7 +2852,7 @@ Key bindings: (define-derived-mode idl-mode prog-mode "IDL" "Major mode for editing CORBA's IDL, PSDL and CIDL code. To submit a problem report, enter `\\[c-submit-bug-report]' from an -idl-mode buffer. This automatically sets up a mail buffer with +`idl-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2879,16 +2878,16 @@ Key bindings: (defvar pike-mode-syntax-table (funcall (c-lang-const c-make-mode-syntax-table pike)) - "Syntax table used in pike-mode buffers.") + "Syntax table used in `pike-mode' buffers.") (defvar pike-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in pike-mode buffers.") + "Keymap used in `pike-mode' buffers.") ;; Additional bindings. (define-key pike-mode-map "\C-c\C-e" 'c-macro-expand) -(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands" +(easy-menu-define c-pike-menu pike-mode-map "Pike Mode Commands." (cons "Pike" (c-lang-const c-mode-menu pike))) ;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(u?lpc\\|pike\\|pmod\\(\\.in\\)?\\)\\'" . pike-mode)) @@ -2898,7 +2897,7 @@ Key bindings: (define-derived-mode pike-mode prog-mode "Pike" "Major mode for editing Pike code. To submit a problem report, enter `\\[c-submit-bug-report]' from a -pike-mode buffer. This automatically sets up a mail buffer with +`pike-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. @@ -2932,7 +2931,7 @@ Key bindings: (defvar awk-mode-map (let ((map (c-make-inherited-keymap))) map) - "Keymap used in awk-mode buffers.") + "Keymap used in `awk-mode' buffers.") ;; Add bindings which are only useful for awk. (define-key awk-mode-map "#" 'self-insert-command);Overrides electric parent binding. (define-key awk-mode-map "/" 'self-insert-command);Overrides electric parent binding. @@ -2945,7 +2944,7 @@ Key bindings: (define-key awk-mode-map "\C-\M-a" 'c-awk-beginning-of-defun) (define-key awk-mode-map "\C-\M-e" 'c-awk-end-of-defun) -(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands" +(easy-menu-define c-awk-menu awk-mode-map "AWK Mode Commands." (cons "AWK" (c-lang-const c-mode-menu awk))) ;; (require 'cc-awk) brings these in. @@ -2956,7 +2955,7 @@ Key bindings: (define-derived-mode awk-mode prog-mode "AWK" "Major mode for editing AWK code. To submit a problem report, enter `\\[c-submit-bug-report]' from an -awk-mode buffer. This automatically sets up a mail buffer with version +`awk-mode' buffer. This automatically sets up a mail buffer with version information already added. You just need to add a description of the problem, including a reproducible test case, and send the message. diff --git a/lisp/progmodes/cc-styles.el b/lisp/progmodes/cc-styles.el index 8514434e9ac..c6b6be5b399 100644 --- a/lisp/progmodes/cc-styles.el +++ b/lisp/progmodes/cc-styles.el @@ -406,7 +406,7 @@ a null operation." ;;;###autoload (defun c-add-style (style description &optional set-p) - "Adds a style to `c-style-alist', or updates an existing one. + "Add a style to `c-style-alist', or update an existing one. STYLE is a string identifying the style to add or update. DESCRIPTION is an association list describing the style and must be of the form: diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el index b33fea0b48c..dcd9546d9aa 100644 --- a/lisp/progmodes/cc-vars.el +++ b/lisp/progmodes/cc-vars.el @@ -1427,23 +1427,23 @@ localized, they cannot be made global again. This variable must be set appropriately before CC Mode is loaded. The list of variables to buffer localize are: - c-basic-offset - c-comment-only-line-offset - c-indent-comment-alist - c-indent-comments-syntactically-p - c-block-comment-prefix - c-comment-prefix-regexp - c-doc-comment-style - c-cleanup-list - c-hanging-braces-alist - c-hanging-colons-alist - c-hanging-semi&comma-criteria - c-backslash-column - c-backslash-max-column - c-label-minimum-indentation - c-offsets-alist - c-special-indent-hook - c-indentation-style" + `c-basic-offset' + `c-comment-only-line-offset' + `c-indent-comment-alist' + `c-indent-comments-syntactically-p' + `c-block-comment-prefix' + `c-comment-prefix-regexp' + `c-doc-comment-style' + `c-cleanup-list' + `c-hanging-braces-alist' + `c-hanging-colons-alist' + `c-hanging-semi&comma-criteria' + `c-backslash-column' + `c-backslash-max-column' + `c-label-minimum-indentation' + `c-offsets-alist' + `c-special-indent-hook' + `c-indentation-style'" :type 'boolean :safe 'booleanp :group 'c) @@ -1864,13 +1864,13 @@ Set from `c-comment-prefix-regexp' at mode initialization.") (defvar c-string-par-start ;; (concat "\\(" (default-value 'paragraph-start) "\\)\\|[ \t]*\\\\$") "\f\\|[ \t]*\\\\?$" - "Value of paragraph-start used when scanning strings. + "Value of `paragraph-start' used when scanning strings. It treats escaped EOLs as whitespace.") (defvar c-string-par-separate ;; (concat "\\(" (default-value 'paragraph-separate) "\\)\\|[ \t]*\\\\$") "[ \t\f]*\\\\?$" - "Value of paragraph-separate used when scanning strings. + "Value of `paragraph-separate' used when scanning strings. It treats escaped EOLs as whitespace.") (defvar c-sentence-end-with-esc-eol @@ -1878,7 +1878,7 @@ It treats escaped EOLs as whitespace.") ;; N.B.: "$" would be illegal when not enclosed like "\\($\\)". "\\|" "[.?!][]\"')}]* ?\\\\\\($\\)[ \t\n]*" "\\)") - "Value used like sentence-end used when scanning strings. + "Value used like `sentence-end' used when scanning strings. It treats escaped EOLs as whitespace.") diff --git a/lisp/progmodes/cperl-mode.el b/lisp/progmodes/cperl-mode.el index 1147889969b..634dd29bad6 100644 --- a/lisp/progmodes/cperl-mode.el +++ b/lisp/progmodes/cperl-mode.el @@ -308,7 +308,7 @@ Can be overwritten by `cperl-hairy' if nil." Can be overwritten by `cperl-hairy' if nil. Uses `abbrev-mode' to do the expansion. If you want to use your -own abbrevs in cperl-mode, but do not want keywords to be +own abbrevs in `cperl-mode', but do not want keywords to be electric, you must redefine `cperl-mode-abbrev-table': do \\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in that paragraph, delete the words that appear at the ends of lines and @@ -1584,7 +1584,7 @@ into \\{cperl-mode-map} -Setting the variable `cperl-font-lock' to t switches on font-lock-mode +Setting the variable `cperl-font-lock' to t switches on `font-lock-mode' \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches on electric space between $ and {, `cperl-electric-parens-string' is the string that contains parentheses that should be electric in CPerl @@ -2577,9 +2577,9 @@ Return the amount the indentation changed by." (not (in ":")))))))) (defun cperl-get-state (&optional parse-start start-state) - "Return list (START STATE DEPTH PRESTART), + "Return list (START STATE DEPTH PRESTART). START is a good place to start parsing, or equal to -PARSE-START if preset, +PARSE-START if preset. STATE is what is returned by `parse-partial-sexp'. DEPTH is true is we are immediately after end of block which contains START. @@ -3110,8 +3110,9 @@ and closing parentheses and brackets." (error "Got strange value of indent: %s" i)))))) (defun cperl-calculate-indent-within-comment () - "Return the indentation amount for line, assuming that -the current line is to be regarded as part of a block comment." + "Return the indentation amount for line. +Assume that the current line is to be regarded as part of a block +comment." (let (end) (save-excursion (beginning-of-line) @@ -8523,7 +8524,7 @@ If a region is highlighted, restricts to the region." beg end)))) (defun cperl-map-pods-heres (func &optional prop s end) - "Executes a function over regions of pods or here-documents. + "Execute a function over regions of pods or here-documents. PROP is the text-property to search for; default to `in-pod'. Stop when function returns nil." (let (pos posend has-prop (cont t)) @@ -8698,7 +8699,7 @@ Delay of auto-help controlled by `cperl-lazy-help-time'." (remove-text-properties beg end '(face nil)))) (defun cperl-font-lock-fontify-region-function (beg end loudly) - "Extends the region to safe positions, then calls the default function. + "Extend the region to safe positions, then call the default function. Newer `font-lock's can do it themselves. We unwind only as far as needed for fontification. Syntaxification may do extra unwind via `cperl-unwind-to-safe'." diff --git a/lisp/progmodes/ebnf-dtd.el b/lisp/progmodes/ebnf-dtd.el index 93bae5a33c5..9185711848c 100644 --- a/lisp/progmodes/ebnf-dtd.el +++ b/lisp/progmodes/ebnf-dtd.el @@ -56,14 +56,14 @@ ;; ;; Char ::= #x9 | #xA | #xD ;; | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] -;; /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */ +;; /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */ ;; ;; /* NOTE: ;; ;; Document authors are encouraged to avoid "compatibility characters", as ;; defined in section 6.8 of [Unicode] (see also D21 in section 3.6 of ;; [Unicode3]). The characters defined in the following ranges are also -;; discouraged. They are either control characters or permanently undefined +;; discouraged. They are either control characters or permanently undefined ;; Unicode characters: ;; ;; [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF], @@ -72,7 +72,7 @@ ;; [#7FFFE-#x7FFFF], [#8FFFE-#x8FFFF], [#9FFFE-#x9FFFF], ;; [#AFFFE-#xAFFFF], [#BFFFE-#xBFFFF], [#CFFFE-#xCFFFF], ;; [#DFFFE-#xDFFFF], [#EFFFE-#xEFFFF], [#FFFFE-#xFFFFF], -;; [#10FFFE-#x10FFFF]. */ +;; [#10FFFE-#x10FFFF]. */ ;; ;; ;; /* White Space */ @@ -115,7 +115,7 @@ ;; Although the EntityValue production allows the definition of a general ;; entity consisting of a single explicit < in the literal (e.g., <!ENTITY ;; mylt "<">), it is strongly advised to avoid this practice since any -;; reference to that entity will cause a well-formedness error. */ +;; reference to that entity will cause a well-formedness error. */ ;; ;; ;; /* Character Data */ diff --git a/lisp/progmodes/ebnf-ebx.el b/lisp/progmodes/ebnf-ebx.el index 5d8541931e1..ae48881ee9e 100644 --- a/lisp/progmodes/ebnf-ebx.el +++ b/lisp/progmodes/ebnf-ebx.el @@ -43,7 +43,7 @@ ;; ;; ;; rule ::= symbol '::=' expression -;; /* rules are separated by at least one blank line. */ +;; /* rules are separated by at least one blank line. */ ;; ;; expression ::= concatenation ('|' concatenation)* ;; diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el index 55325ef488b..d40ae476a69 100644 --- a/lisp/progmodes/elisp-mode.el +++ b/lisp/progmodes/elisp-mode.el @@ -204,7 +204,7 @@ All commands in `lisp-mode-shared-map' are inherited by this map.") Load the compiled code when finished. Use `emacs-lisp-byte-compile-and-load' in combination with -`native-comp-deferred-compilation' set to `t' to achieve asynchronous +`native-comp-deferred-compilation' set to t to achieve asynchronous native compilation." (interactive nil emacs-lisp-mode) (emacs-lisp--before-compile-buffer) @@ -1249,7 +1249,7 @@ this command arranges for all errors to enter the debugger." (defun last-sexp-setup-props (beg end value alt1 alt2) "Set up text properties for the output of `elisp--eval-last-sexp'. -BEG and END are the start and end of the output in current-buffer. +BEG and END are the start and end of the output in current buffer. VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the alternative printed representations that can be displayed." (let ((map (make-sparse-keymap))) diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index cddf3ba0b98..e6af2b12c73 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -749,7 +749,7 @@ Returns t if it visits a tags table, or nil if there are no more in the list." "Return the file name of the file whose tags point is within. Assumes the tags table is the current buffer. If RELATIVE is non-nil, file name returned is relative to tags -table file's directory. If RELATIVE is nil, file name returned +table file's directory. If RELATIVE is nil, file name returned is complete." (funcall file-of-tag-function relative)) diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index 5c0b7880e8b..3f2c9b71485 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -64,10 +64,11 @@ ;; The function f90-comment-region toggles insertion of ;; the variable f90-comment-region in every line of the region. -;; One common convention for free vs. fixed format is that free format files -;; have the ending .f90 or .f95 while fixed format files have the ending .f. -;; Emacs automatically loads Fortran files in the appropriate mode based -;; on extension. You can modify this by adjusting the variable auto-mode-alist. +;; One common convention for free vs. fixed format is that free format +;; files have the ending .f90 or .f95 while fixed format files have +;; the ending .f. Emacs automatically loads Fortran files in the +;; appropriate mode based on extension. You can modify this by +;; adjusting the variable `auto-mode-alist'. ;; For example: ;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode)) @@ -104,21 +105,21 @@ ;; (if f90-auto-keyword-case ; change case of all keywords on startup ;; (f90-change-keywords f90-auto-keyword-case)))) ;; -;; in your init file. You can also customize the lists -;; f90-font-lock-keywords, etc. +;; in your init file. You can also customize the lists +;; `f90-font-lock-keywords', etc. ;; ;; The auto-fill and abbreviation minor modes are accessible from the F90 menu, ;; or by using M-x auto-fill-mode and M-x abbrev-mode, respectively. ;; Remarks -;; 1) Line numbers are by default left-justified. If f90-leave-line-no is +;; 1) Line numbers are by default left-justified. If f90-leave-line-no is ;; non-nil, the line numbers are never touched. ;; 2) Multi-; statements like "do i=1,20 ; j=j+i ; end do" are not handled ;; correctly, but I imagine them to be rare. ;; 3) Regexps for hilit19 are no longer supported. ;; 4) For FIXED FORMAT code, use fortran mode. ;; 5) Preprocessor directives, i.e., lines starting with # are left-justified -;; and are untouched by all case-changing commands. There is, at present, no +;; and are untouched by all case-changing commands. There is, at present, no ;; mechanism for treating multi-line directives (continued by \ ). ;; 6) f77 do-loops do 10 i=.. ; ; 10 continue are not correctly indented. ;; You are urged to use f90-do loops (with labels if you wish). @@ -140,7 +141,7 @@ ;; f90-font-lock-1, f90-font-lock-2, f90-font-lock-3, f90-font-lock-4 ;; Original author's thanks -;; Thanks to all the people who have tested the mode. Special thanks to Jens +;; Thanks to all the people who have tested the mode. Special thanks to Jens ;; Bloch Helmers for encouraging me to write this code, for creative ;; suggestions as well as for the lists of hpf-commands. ;; Also thanks to the authors of the fortran and pascal modes, on which some diff --git a/lisp/progmodes/flymake-cc.el b/lisp/progmodes/flymake-cc.el index 907300eb274..3ae3fcb9fec 100644 --- a/lisp/progmodes/flymake-cc.el +++ b/lisp/progmodes/flymake-cc.el @@ -99,7 +99,7 @@ SOURCE." (cond ((derived-mode-p 'c++-mode) "c++") (t "c"))))) -(defvar-local flymake-cc--proc nil "Internal variable for `flymake-cc'") +(defvar-local flymake-cc--proc nil "Internal variable for `flymake-cc'.") ;; forward declare this to shoosh compiler (instead of requiring ;; flymake-proc) diff --git a/lisp/progmodes/flymake-proc.el b/lisp/progmodes/flymake-proc.el index 9cbad121d1f..27b46a45c50 100644 --- a/lisp/progmodes/flymake-proc.el +++ b/lisp/progmodes/flymake-proc.el @@ -188,10 +188,14 @@ Convert it to Flymake internal format." 2 4 5 6)) ;; compilation-error-regexp-alist) (flymake-proc-reformat-err-line-patterns-from-compile-el compilation-error-regexp-alist-alist)) - "Patterns for matching error/warning lines. Each pattern has the form -\(REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX). -Use `flymake-proc-reformat-err-line-patterns-from-compile-el' to add patterns -from compile.el") + "Patterns for matching error/warning lines. + +Each pattern has the form: + + (REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX) + +Use `flymake-proc-reformat-err-line-patterns-from-compile-el' to +add patterns from compile.el.") (define-obsolete-variable-alias 'flymake-warning-re 'flymake-proc-diagnostic-type-pred "26.1") (defvar flymake-proc-diagnostic-type-pred @@ -760,7 +764,7 @@ May only be called in a dynamic environment where (defun flymake-proc-legacy-flymake (report-fn &rest args) "Flymake backend based on the original Flymake implementation. This function is suitable for inclusion in -`flymake-diagnostic-functions'. For backward compatibility, it +`flymake-diagnostic-functions'. For backward compatibility, it can also be executed interactively independently of `flymake-mode'." ;; Interactively, behave as if flymake had invoked us through its diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index fb612eebc77..e8ce0e723e4 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -1747,7 +1747,7 @@ some of this variable's contents the diagnostic listings.") (revert-buffer)))) (defun flymake--update-diagnostics-listings (buffer) - "Update diagnostics listings somehow relevant to BUFFER" + "Update diagnostics listings somehow relevant to BUFFER." (dolist (probe (buffer-list)) (with-current-buffer probe (when (or (and (eq major-mode 'flymake-project-diagnostics-mode) diff --git a/lisp/progmodes/fortran.el b/lisp/progmodes/fortran.el index 707226fb2a5..7cf4ce27305 100644 --- a/lisp/progmodes/fortran.el +++ b/lisp/progmodes/fortran.el @@ -749,7 +749,7 @@ Variables controlling indentation style and extra features: `fortran-comment-line-extra-indent' Amount of extra indentation for text in full-line comments (default 0). `fortran-comment-indent-style' - How to indent the text in full-line comments. Allowed values are: + How to indent the text in full-line comments. Allowed values are: nil don't change the indentation `fixed' indent to `fortran-comment-line-extra-indent' beyond the value of either diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 41384e129b0..902466e4feb 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -788,7 +788,7 @@ becomes the initial working directory and source-file directory for your debugger. If COMMAND-LINE requests that gdb attaches to a process PID, gdb will run in *gud-PID*, otherwise it will run in *gud*; in these -cases the initial working directory is the default-directory of +cases the initial working directory is the `default-directory' of the buffer in which this command was invoked. COMMAND-LINE should include \"-i=mi\" to use gdb's MI text interface. diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el index b2a9b3e3206..d7f4582dd0b 100644 --- a/lisp/progmodes/grep.el +++ b/lisp/progmodes/grep.el @@ -523,7 +523,7 @@ This variable's value takes effect when `grep-compute-defaults' is called." ;;;###autoload (defvar grep-history nil "History list for grep.") ;;;###autoload -(defvar grep-find-history nil "History list for grep-find.") +(defvar grep-find-history nil "History list for `grep-find'.") ;; History of lgrep and rgrep regexp and files args. (defvar grep-regexp-history nil) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index d8c77f7f231..2061d414802 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -31,7 +31,7 @@ ;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey ;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love ;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant -;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX +;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories. ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java ;; debugger.) Jan Nieuwenhuizen added support for the Guile REPL (Guile @@ -795,7 +795,7 @@ becomes the initial working directory and source-file directory for your debugger. If COMMAND-LINE requests that gdb attaches to a process PID, gdb will run in *gud-PID*, otherwise it will run in *gud*; in these -cases the initial working directory is the default-directory of +cases the initial working directory is the `default-directory' of the buffer in which this command was invoked." (interactive (list (gud-query-cmdline 'gud-gdb))) @@ -2677,8 +2677,8 @@ gud, see `gud-mode'." (define-derived-mode gud-mode comint-mode "Debugger" "Major mode for interacting with an inferior debugger process. - You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx, -M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a + You start it up with one of the commands \\[gdb], \\[sdb], \\[dbx], +\\[perldb], \\[xdb], or \\[jdb]. Each entry point finishes by executing a hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook', `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively. @@ -3333,7 +3333,7 @@ This function uses the `gud-jdb-classpath' (and optional `gud-jdb-sourcepath') list(s) to derive a file pathname relative to its classpath directory. The values in `gud-jdb-classpath' are assumed to have been converted to absolute -pathname standards using file-truename. +pathname standards using `file-truename'. If F is visited by a buffer and its mode is CC-mode(Java), syntactic information of LINE is used to find the enclosing (nested) class string which is appended to the top level diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index 7cd49a69d4a..a18a67249ae 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -1071,7 +1071,7 @@ Assuming we've just performed a `hif-token-regexp' lookup." (error "`defined' followed by non-identifier: %S" target)) (if (and paren (not (eq (hif-nexttoken) 'hif-rparen))) - (error "missing right parenthesis for `defined'")) + (error "Missing right parenthesis for `defined'")) (setq hif-token (list 'hif-defined 'hif-lparen target 'hif-rparen))) (push hif-token tokens)) diff --git a/lisp/progmodes/idlw-complete-structtag.el b/lisp/progmodes/idlw-complete-structtag.el index 6d2d402e358..bf49c92552a 100644 --- a/lisp/progmodes/idlw-complete-structtag.el +++ b/lisp/progmodes/idlw-complete-structtag.el @@ -44,7 +44,7 @@ ;; completion for its tags. ;; ;; This file is a completion plugin which implements this kind of -;; completion. It is also an example which shows how completion plugins +;; completion. It is also an example which shows how completion plugins ;; should be programmed. ;; ;; New versions of IDLWAVE, documentation, and more information available @@ -86,6 +86,8 @@ ;; - You can force an update of the tag list with the usual command ;; to update routine info in IDLWAVE: C-c C-i +;;; Code: + (require 'idlwave) (declare-function idlwave-shell-buffer "idlw-shell") diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index b90bbedd453..ffa3d78b4d2 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -218,9 +218,8 @@ support." ;; Define the menu for the Help application -(easy-menu-define - idlwave-help-menu idlwave-help-mode-map - "Menu for Help IDLWAVE system" +(easy-menu-define idlwave-help-menu idlwave-help-mode-map + "Menu for Help IDLWAVE system." '("IDLHelp" ["Definition <-> Help Text" idlwave-help-toggle-header-match-and-def t] ["Find DocLib Header" idlwave-help-find-header t] diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index f2bfbf3e379..fc3d603f066 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -124,7 +124,7 @@ process output is made by surrounding this name with `*'s." (defcustom idlwave-shell-frame-parameters '((height . 30) (unsplittable . nil)) - "The frame parameters for a dedicated idlwave-shell frame. + "The frame parameters for a dedicated `idlwave-shell' frame. See also `idlwave-shell-use-dedicated-frame'. The default makes the frame splittable, so that completion works correctly." :group 'idlwave-shell-general-setup @@ -154,10 +154,10 @@ t Arrows force the cursor back to the current command line and (defcustom idlwave-shell-use-toolbar t "Non-nil means, use the debugging toolbar in all IDL related buffers. -Starting the shell will then add the toolbar to all idlwave-mode buffers. +Starting the shell will then add the toolbar to all `idlwave-mode' buffers. Exiting the shell will removed everywhere. At any time you can toggle the display of the toolbar with -`C-c C-d C-t' (`idlwave-shell-toggle-toolbar')." +\\[idlwave-shell-toggle-toolbar]." :group 'idlwave-shell-general-setup :type 'boolean) @@ -550,7 +550,7 @@ the expression output by IDL." ;; Other variables (defvar idlwave-shell-temp-pro-file nil - "Absolute pathname for temporary IDL file for compiling regions") + "Absolute pathname for temporary IDL file for compiling regions.") (defvar idlwave-shell-temp-rinfo-save-file nil "Absolute pathname for temporary IDL file save file for routine_info. @@ -590,7 +590,7 @@ the directory stack.") "Additional info displayed in the mode line.") (defvar idlwave-shell-default-directory nil - "The default directory in the idlwave-shell buffer, of outside use.") + "The default directory in the `idlwave-shell' buffer, of outside use.") (defvar idlwave-shell-last-save-and-action-file nil "The last file which was compiled with `idlwave-shell-save-and-...'.") @@ -734,9 +734,9 @@ IDL is currently stopped.") (defconst idlwave-shell-trace-message-re "^% At " ;; First line of a trace message - "A regular expression matching IDL trace messages. These are the -messages containing file and line information of a current -traceback.") + "A regular expression matching IDL trace messages. +These are the messages containing file and line information of a +current traceback.") (defconst idlwave-shell-step-messages '("^% Stepped to:" @@ -1384,14 +1384,14 @@ Otherwise just move the line. Move down unless UP is non-nil." (forward-line (- arg))))) (defun idlwave-shell-up-or-history (&optional arg) -"When in last line of process buffer, move to previous input. - Otherwise just go up one line." + "When in last line of process buffer, move to previous input. +Otherwise just go up one line." (interactive "p") (idlwave-shell-move-or-history t arg)) (defun idlwave-shell-down-or-history (&optional arg) -"When in last line of process buffer, move to next input. - Otherwise just go down one line." + "When in last line of process buffer, move to next input. +Otherwise just go down one line." (interactive "p") (idlwave-shell-move-or-history nil arg)) @@ -1897,7 +1897,7 @@ HEAP_GC, /VERBOSE" (cons sysdir (nreverse dirs)))) (defun idlwave-shell-routine-info-filter () - "Function which parses the special output from idlwave_routine_info.pro." + "Parse the special output from idlwave_routine_info.pro." (let ((text idlwave-shell-command-output) (start 0) sep sep-re file type spec specs name cs key keys class entry) @@ -2056,7 +2056,7 @@ Change the default directory for the process buffer to concur." (idlwave-new-sintern-type execcomm) (defun idlwave-shell-complete (&optional arg) - "Do completion in the idlwave-shell buffer. + "Do completion in the `idlwave-shell' buffer. Calls `idlwave-shell-complete-filename' after some executive commands or in strings. Otherwise, calls `idlwave-complete' to complete modules and keywords." @@ -2136,7 +2136,7 @@ args of an executive .run, .rnew or .compile." (and (memq (preceding-char) '(?\' ?\")) t)))) (defun idlwave-shell-batch-command () - "Return t if we're in a batch command statement like @foo" + "Return t if we're in a batch command statement like \"@foo\"." (let ((limit (point-at-bol))) (save-excursion ;; Skip backwards over filename @@ -2145,7 +2145,7 @@ args of an executive .run, .rnew or .compile." (and (eq (preceding-char) ?@) (not (idlwave-in-quote)))))) (defun idlwave-shell-shell-command () - "Return t if we're in a shell command statement like $ls" + "Return t if we're in a shell command statement like \"$ls\"." (save-excursion (idlwave-beginning-of-statement) (looking-at "\\$"))) @@ -2276,7 +2276,7 @@ matter what the settings of that variable." (if (not (idlwave-shell-valid-frame frame)) ;; fixme: errors are dangerous in shell filters. but i think i ;; have never encountered this one. - (error "invalid frame - unable to access file: %s" (car frame)) + (error "Invalid frame - unable to access file: %s" (car frame)) ;; ;; buffer : the buffer to display a line in. ;; select-shell: current buffer is the shell. @@ -3147,14 +3147,14 @@ index - the index number of the breakpoint internal to IDL. module - the module for breakpoint internal to IDL. Remaining elements of the cdr: -data - Data associated with the breakpoint by idlwave-shell currently +data - Data associated with the breakpoint by `idlwave-shell' currently contains four items: count - number of times to execute breakpoint. When count reaches 0 the breakpoint is cleared and removed from the alist. command - command to execute when breakpoint is reached, either a - lisp function to be called with `funcall' with no arguments or a + Lisp function to be called with `funcall' with no arguments or a list to be evaluated with `eval'. condition - any condition to apply to the breakpoint. @@ -4316,11 +4316,11 @@ Shell debugging commands are available as single key sequences." ["Toggle Toolbar" idlwave-shell-toggle-toolbar t] ["Exit IDL" idlwave-shell-quit t])) -(easy-menu-define - idlwave-mode-debug-menu idlwave-mode-map "IDL debugging menus" +(easy-menu-define idlwave-mode-debug-menu idlwave-mode-map + "IDL debugging menus." idlwave-shell-menu-def) -(easy-menu-define - idlwave-shell-mode-menu idlwave-shell-mode-map "IDL shell menus" +(easy-menu-define idlwave-shell-mode-menu idlwave-shell-mode-map + "IDL shell menus." idlwave-shell-menu-def) ;; The Breakpoint Glyph ------------------------------------------------------- diff --git a/lisp/progmodes/idlw-toolbar.el b/lisp/progmodes/idlw-toolbar.el index d3f47fcf45e..c3ffcd18ced 100644 --- a/lisp/progmodes/idlw-toolbar.el +++ b/lisp/progmodes/idlw-toolbar.el @@ -355,7 +355,7 @@ static char * file[] = { \" \", \" \", \" \"};") - "The edit-cmd icon") + "The edit-cmd icon.") (defvar idlwave-toolbar-run-icon (idlwave-toolbar-make-button diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 91be4016232..ce984d32b53 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -119,7 +119,7 @@ ;; ;; Moving the point backwards in conjunction with abbrev expansion ;; does not work as I would like it, but this is a problem with -;; emacs abbrev expansion done by the self-insert-command. It ends +;; Emacs abbrev expansion done by the self-insert-command. It ends ;; up inserting the character that expanded the abbrev after moving ;; point backward, e.g., "\cl" expanded with a space becomes ;; "LONG( )" with point before the close paren. This is solved by @@ -1359,7 +1359,7 @@ Normally a space.") (defconst idlwave-continuation-char ?$ "Character which is inserted as a last character on previous line by - \\[idlwave-split-line] to begin a continuation line. Normally $.") +\\[idlwave-split-line] to begin a continuation line. Normally $.") (defconst idlwave-mode-version "6.1_em22") @@ -1953,7 +1953,7 @@ The main features of this mode are (defvar idlwave--command-function nil "If non-nil, a function called from `post-command-hook'. -It is evaluated in the lisp function `idlwave-command-hook' which is +It is evaluated in the Lisp function `idlwave-command-hook' which is placed in `post-command-hook'.") (defun idlwave-command-hook () @@ -4067,7 +4067,7 @@ blank lines." iname)) (defun idlwave-sintern-keyword-list (kwd-list &optional set) - "Sintern a set of keywords (file (key . link) (key2 . link2) ...)" + "Sintern a set of keywords (file (key . link) (key2 . link2) ...)." (mapc (lambda(x) (setcar x (idlwave-sintern-keyword (car x) set))) (cdr kwd-list)) @@ -5049,7 +5049,7 @@ Can run from `after-save-hook'." ;;----- Scanning buffers ------------------- (defun idlwave-get-routine-info-from-buffers (buffers) - "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS." + "Call `idlwave-get-buffer-routine-info' on `idlwave-mode' buffers in BUFFERS." (let (buf routine-lists res) (save-excursion (while (setq buf (pop buffers)) @@ -8971,10 +8971,10 @@ Assumes that point is at the beginning of the unit as found by idlwave-shell-automatic-start)])) (easy-menu-define idlwave-mode-menu idlwave-mode-map - "IDL and WAVE CL editing menu" + "IDL and WAVE CL editing menu." idlwave-mode-menu-def) (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map - "IDL and WAVE CL editing menu" + "IDL and WAVE CL editing menu." idlwave-mode-debug-menu-def) (defun idlwave-customize () diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index c2481f6095a..845ca8609d7 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -24,9 +24,9 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. -;;; Commentary +;;; Commentary: -;; This is based on Karl Landstrom's barebones javascript-mode. This +;; This is based on Karl Landstrom's barebones javascript-mode. This ;; is much more robust and works with cc-mode's comment filling ;; (mostly). ;; @@ -237,8 +237,7 @@ will create multiple top-level entries. Don't use :prototype unnecessarily: it has an associated cost in performance. If :strip-prototype is present and non-nil, then if the class -name as matched contains -") +name as matched contains.") (defconst js--available-frameworks (cl-loop for style in js--class-styles @@ -554,8 +553,7 @@ If the previous expression also contains a \".\" at the same level, then the \".\"s will be lined up: let x = svg.mumble() - .chained; -" + .chained;" :version "26.1" :type 'boolean :safe 'booleanp) @@ -574,8 +572,8 @@ to `js-jsx-regexps', which see." This enables proper font-locking and indentation of code using Facebook’s “JSX” syntax extension for JavaScript, for use with -Facebook’s “React” library. Font-locking is like sgml-mode. -Indentation is also like sgml-mode, although some indentation +Facebook’s “React” library. Font-locking is like `sgml-mode'. +Indentation is also like `sgml-mode', although some indentation behavior may differ slightly to align more closely with the conventions of the React developer community. @@ -3267,7 +3265,7 @@ the broken-down class name of the item to insert." (defun js--get-all-known-symbols () "Return a hash table of all JavaScript symbols. -This searches all existing `js-mode' buffers. Each key is the +This searches all existing `js-mode' buffers. Each key is the name of a symbol (possibly disambiguated with <N>, where N > 1), and each value is a marker giving the location of that symbol." (cl-loop with symbols = (make-hash-table :test 'equal) diff --git a/lisp/progmodes/ld-script.el b/lisp/progmodes/ld-script.el index 485e64e2492..879eb720651 100644 --- a/lisp/progmodes/ld-script.el +++ b/lisp/progmodes/ld-script.el @@ -167,11 +167,11 @@ ("\\W\\(\\.\\)\\W" 1 ld-script-location-counter-face) ) cpp-font-lock-keywords) - "Default font-lock-keywords for `ld-script-mode'.") + "Default `font-lock-keywords' for `ld-script-mode'.") ;;;###autoload (define-derived-mode ld-script-mode prog-mode "LD-Script" - "A major mode to edit GNU ld script files" + "A major mode to edit GNU ld script files." (setq-local comment-start "/* ") (setq-local comment-end " */") (setq-local font-lock-defaults '(ld-script-font-lock-keywords nil))) diff --git a/lisp/progmodes/octave.el b/lisp/progmodes/octave.el index b1a5f301587..6bf070cf9e5 100644 --- a/lisp/progmodes/octave.el +++ b/lisp/progmodes/octave.el @@ -351,7 +351,7 @@ Non-nil means always go to the next Octave code line after sending." ;; corresponding continuation lines). (defun octave-smie--funcall-p () - "Return non-nil if we're in an expression context. Moves point." + "Return non-nil if we're in an expression context. Move point." (looking-at "[ \t]*(")) (defun octave-smie--end-index-p () @@ -1034,7 +1034,7 @@ directory and makes this the current buffer's default directory." (nth 8 (syntax-ppss))) (defun octave-looking-at-kw (regexp) - "Like `looking-at', but sets `case-fold-search' nil." + "Like `looking-at', but set `case-fold-search' nil first." (let ((case-fold-search nil)) (looking-at regexp))) diff --git a/lisp/progmodes/opascal.el b/lisp/progmodes/opascal.el index 662d2b4b74f..51c888d25f3 100644 --- a/lisp/progmodes/opascal.el +++ b/lisp/progmodes/opascal.el @@ -24,9 +24,10 @@ ;;; Commentary: -;; To enter OPascal mode when you find an Object Pascal source file, one must -;; override the auto-mode-alist to associate OPascal with .pas (and .dpr and -;; .dpk) files. Emacs, by default, will otherwise enter Pascal mode. E.g. +;; To enter OPascal mode when you find an Object Pascal source file, +;; one must override the auto-mode-alist to associate OPascal with +;; .pas (and .dpr and .dpk) files. Emacs, by default, will otherwise +;; enter Pascal mode. For example: ;; ;; (autoload 'opascal-mode "opascal") ;; (add-to-list 'auto-mode-alist @@ -244,8 +245,8 @@ are followed by an expression.") (defconst opascal-begin-previous-tokens `(,@opascal-decl-sections ,@opascal-routine-statements) - "Tokens that a begin token aligns with, but only if not part of a nested -routine.") + "Tokens that a begin token aligns with, but only if not part of a \ +nested routine.") (defconst opascal-space-chars "\000-\011\013- ") ; all except \n (defconst opascal-non-space-chars (concat "^" opascal-space-chars)) @@ -1530,7 +1531,7 @@ If no extension is specified, .pas is assumed. Creates a buffer for the unit." (concat unit ".pas"))) (file (opascal-find-unit-file unit-file))) (if (null file) - (error "unit not found: %s" unit-file) + (error "Unit not found: %s" unit-file) (find-file file) (if (not (derived-mode-p 'opascal-mode)) (opascal-mode))) diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el index 4e14c30bc5d..20834dd2e1e 100644 --- a/lisp/progmodes/perl-mode.el +++ b/lisp/progmodes/perl-mode.el @@ -101,7 +101,7 @@ :version "28.1") (defvar perl-mode-abbrev-table nil - "Abbrev table in use in perl-mode buffers.") + "Abbrev table in use in `perl-mode' buffers.") (define-abbrev-table 'perl-mode-abbrev-table ()) (defvar perl-mode-map @@ -509,7 +509,7 @@ (defface perl-heredoc '((t (:inherit font-lock-string-face))) - "The face for here-documents. Inherits from font-lock-string-face.") + "The face for here-documents. Inherits from `font-lock-string-face'.") (defun perl-font-lock-syntactic-face-function (state) (cond @@ -644,10 +644,10 @@ the Perl source to be checked as its standard input." ;;;###autoload (defun perl-flymake (report-fn &rest _args) - "Perl backend for Flymake. Launches -`perl-flymake-command' (which see) and passes to its standard -input the contents of the current buffer. The output of this -command is analyzed for error and warning messages." + "Perl backend for Flymake. +Launch `perl-flymake-command' (which see) and pass to its +standard input the contents of the current buffer. The output of +this command is analyzed for error and warning messages." (unless (executable-find (car perl-flymake-command)) (error "Cannot find a suitable checker")) diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el index 2e23c2e2cab..33ca01cc754 100644 --- a/lisp/progmodes/prolog.el +++ b/lisp/progmodes/prolog.el @@ -1272,7 +1272,7 @@ using the commands `send-region', `send-string' and \\[prolog-consult-region]. Commands: Tab indents for Prolog; with argument, shifts rest of expression rigidly with the current line. -Paragraphs are separated only by blank lines and `%%'. `%'s start comments. +Paragraphs are separated only by blank lines and `%%'. `%'s start comments. Return at end of buffer sends line as input. Return not at end copies rest of line to end and sends it. @@ -1352,7 +1352,7 @@ the variable `prolog-prompt-regexp'." (let ((pname (prolog-program-name)) (pswitches (prolog-program-switches))) (if (null pname) - (error "This Prolog system has defined no interpreter.")) + (error "This Prolog system has defined no interpreter")) (unless (comint-check-proc "*prolog*") (with-current-buffer (get-buffer-create "*prolog*") (prolog-inferior-mode) @@ -1641,7 +1641,7 @@ region. This function must be called from the source code buffer." (if prolog-process-flag - (error "Another Prolog task is running.")) + (error "Another Prolog task is running")) (prolog-ensure-process t) (let* ((buffer (get-buffer-create prolog-compilation-buffer)) (real-file buffer-file-name) @@ -2355,7 +2355,7 @@ In effect it sets the `fill-prefix' when inside comments and then calls ) (if prolog-help-function-i (funcall prolog-help-function-i predicate) - (error "Sorry, no help method defined for this Prolog system.")))) + (error "Sorry, no help method defined for this Prolog system")))) )) @@ -2369,7 +2369,7 @@ In effect it sets the `fill-prefix' when inside comments and then calls (pop-to-buffer nil) (Info-goto-node prolog-info-predicate-index) (if (not (re-search-forward str nil t)) - (error "Help on predicate `%s' not found." predicate)) + (error "Help on predicate `%s' not found" predicate)) (setq oldp (point)) (if (re-search-forward str nil t) @@ -2413,7 +2413,7 @@ This function is only available when `prolog-system' is set to `swi'." (process-send-string "prolog" (concat "apropos(" string ").\n")) (display-buffer "*prolog*")) (t - (error "Sorry, no Prolog apropos available for this Prolog system.")))) + (error "Sorry, no Prolog apropos available for this Prolog system")))) (defun prolog-atom-under-point () "Return the atom under or left to the point." @@ -3289,7 +3289,7 @@ PREFIX is the prefix of the search regexp." (easy-menu-define prolog-edit-menu-runtime prolog-mode-map - "Runtime Prolog commands available from the editing buffer" + "Runtime Prolog commands available from the editing buffer." ;; FIXME: Don't use a whole menu for just "Run Mercury". --Stef `("System" ;; Runtime menu name. diff --git a/lisp/progmodes/ps-mode.el b/lisp/progmodes/ps-mode.el index 67c034d0905..68c3cd91fa4 100644 --- a/lisp/progmodes/ps-mode.el +++ b/lisp/progmodes/ps-mode.el @@ -446,7 +446,7 @@ If nil, use `temporary-file-directory'." ps-mode-submit-bug-report t])) -(easy-menu-define ps-mode-main ps-mode-map "PostScript" ps-mode-menu-main) +(easy-menu-define ps-mode-main ps-mode-map "PostScript Menu." ps-mode-menu-main) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 19b79b69197..f848f4c1030 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -542,7 +542,7 @@ the {...} holes that appear within f-strings." (1 font-lock-function-name-face)) (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_)))) (1 font-lock-type-face))) - "Font lock keywords to use in python-mode for level 1 decoration. + "Font lock keywords to use in `python-mode' for level 1 decoration. This is the minimum decoration level, including function and class declarations.") @@ -596,7 +596,7 @@ class declarations.") ;; Extras: "__all__") symbol-end) . font-lock-builtin-face)) - "Font lock keywords to use in python-mode for level 2 decoration. + "Font lock keywords to use in `python-mode' for level 2 decoration. This is the medium decoration level, including everything in `python-font-lock-keywords-level-1', as well as keywords and @@ -712,7 +712,7 @@ avoid '==' being treated as an assignment." (or ")" "]") (* space) assignment-operator)) (1 font-lock-variable-name-face))) - "Font lock keywords to use in python-mode for maximum decoration. + "Font lock keywords to use in `python-mode' for maximum decoration. This decoration level includes everything in `python-font-lock-keywords-level-2', as well as constants, @@ -726,7 +726,7 @@ decorators, exceptions, and assignments.") ; is more than 1, or t (which it is, ; by default). ) - "List of font lock keyword specifications to use in python-mode. + "List of font lock keyword specifications to use in `python-mode'. Which one will be chosen depends on the value of `font-lock-maximum-decoration'.") @@ -3072,13 +3072,12 @@ of `error' with a user-friendly message." (or (python-shell-get-process) (if interactivep (user-error - "Start a Python process first with `M-x run-python' or `%s'." + "Start a Python process first with `M-x run-python' or `%s'" ;; Get the binding. (key-description (where-is-internal #'run-python overriding-local-map t))) - (error - "No inferior Python process running.")))) + (error "No inferior Python process running")))) (defun python-shell-get-or-create-process (&optional cmd dedicated show) "Get or create an inferior Python process for current buffer and return it. @@ -4714,10 +4713,10 @@ returns will be used. If not FORCE-PROCESS is passed what docstring))))) (defvar-local python-eldoc-get-doc t - "Non-nil means eldoc should fetch the documentation - automatically. Set to nil by `python-eldoc-function' if - `python-eldoc-function-timeout-permanent' is non-nil and - `python-eldoc-function' times out.") + "Non-nil means eldoc should fetch the documentation automatically. +Set to nil by `python-eldoc-function' if +`python-eldoc-function-timeout-permanent' is non-nil and +`python-eldoc-function' times out.") (defcustom python-eldoc-function-timeout 1 "Timeout for `python-eldoc-function' in seconds." diff --git a/lisp/progmodes/ruby-mode.el b/lisp/progmodes/ruby-mode.el index 6a03856eafc..b0b055bd361 100644 --- a/lisp/progmodes/ruby-mode.el +++ b/lisp/progmodes/ruby-mode.el @@ -151,10 +151,8 @@ This should only be called after matching against `ruby-here-doc-beg-re'." map) "Keymap used in Ruby mode.") -(easy-menu-define - ruby-mode-menu - ruby-mode-map - "Ruby Mode Menu" +(easy-menu-define ruby-mode-menu ruby-mode-map + "Ruby Mode Menu." '("Ruby" ["Beginning of Block" ruby-beginning-of-block t] ["End of Block" ruby-end-of-block t] @@ -936,7 +934,7 @@ Can be one of `heredoc', `modifier', `expr-qstr', `expr-re'." (defun ruby-forward-string (term &optional end no-error expand) "Move forward across one balanced pair of string delimiters. -Skips escaped delimiters. If EXPAND is non-nil, also ignores +Skips escaped delimiters. If EXPAND is non-nil, also ignores delimiters in interpolated strings. TERM should be a string containing either a single, self-matching diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index d144d68b571..02eccb33012 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -2794,7 +2794,7 @@ See `sql-product-alist' for a list of products and supported features." (symbolp v)) (symbol-value v) v)) - (error "`%s' is not a known product; use `sql-add-product' to add it first." product) + (error "`%s' is not a known product; use `sql-add-product' to add it first" product) nil))) (defun sql-product-font-lock (keywords-only imenu) @@ -2952,7 +2952,7 @@ adds a fontification pattern to fontify identifiers ending in "Display a SQLi buffer based on `sql-display-sqli-buffer-function'. If BUF is hidden or `sql-display-sqli-buffer-function' is nil, -then the buffer will not be displayed. Otherwise the BUF is +then the buffer will not be displayed. Otherwise the BUF is displayed." (unless (sql-buffer-hidden-p buf) (cond diff --git a/lisp/progmodes/tcl.el b/lisp/progmodes/tcl.el index f6a50bf1a88..b6a7a20d87f 100644 --- a/lisp/progmodes/tcl.el +++ b/lisp/progmodes/tcl.el @@ -288,7 +288,7 @@ quoted for Tcl." ["Tcl help" tcl-help-on-word tcl-help-directory-list])) (defvar inferior-tcl-buffer nil - "The current inferior-tcl process buffer. + "The current `inferior-tcl' process buffer. MULTIPLE PROCESS SUPPORT =========================================================================== diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 2b5f85df2f9..ef2c21da456 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -829,7 +829,7 @@ The name of the function or case will be set between the braces." (defcustom verilog-auto-ignore-concat nil "Non-nil means ignore signals in {...} concatenations for AUTOWIRE etc. This will exclude signals referenced as pin connections in {...} -or (...) from AUTOWIRE, AUTOOUTPUT and friends. See also AUTONOHOOKUP." +or (...) from AUTOWIRE, AUTOOUTPUT and friends. See also AUTONOHOOKUP." :group 'verilog-mode-actions :type 'boolean) (put 'verilog-auto-ignore-concat 'safe-local-variable #'verilog-booleanp) @@ -1529,8 +1529,8 @@ If set will become buffer local.") "Keymap used in Verilog mode.") ;; menus -(easy-menu-define - verilog-menu verilog-mode-map "Menu for Verilog mode" +(easy-menu-define verilog-menu verilog-mode-map + "Menu for Verilog mode." (verilog-easy-menu-filter `("Verilog" ("Choose Compilation Action" @@ -3610,19 +3610,19 @@ inserted using a single call to `verilog-insert'." (search-forward ";" nil t)) (defun verilog-single-declaration-end (limit) - "Returns pos where current (single) declaration statement ends. + "Return pos where current (single) declaration statement ends. Also, this function moves POINT forward to the start of a variable name (skipping the range-part and whitespace). Function expected to be called with POINT just after a declaration keyword. -LIMIT sets the max POINT for searching and moving to. No such limit if LIMIT +LIMIT sets the max POINT for searching and moving to. No such limit if LIMIT is 0. Meaning of *single* declaration: - Eg. In a module's port-list - + E.g. In a module's port-list - module test(input clk, rst, x, output [1:0] y); Here 'input clk, rst, x' is 1 *single* declaration statement, and 'output [1:0] y' is the other single declaration. In the 1st single -declaration, POINT is moved to start of 'clk'. And in the 2nd declaration, +declaration, POINT is moved to start of 'clk'. And in the 2nd declaration, POINT is moved to 'y'." @@ -13651,7 +13651,7 @@ signals to deasserted. the same input/output list as another module, but no internals. Specifically, it finds all outputs in the module, and if that input is not otherwise declared as a register or wire, nor comes -from a AUTOINST submodule's output, creates a tieoff. AUTOTIEOFF +from a AUTOINST submodule's output, creates a tieoff. AUTOTIEOFF does not examine assignments to determine what is already driven. AUTORESET ties signals to deasserted, which is presumed to be zero. @@ -14428,7 +14428,7 @@ See also `verilog-header' for an alternative format." ;; ------------------------------------------------------------------------ (define-skeleton verilog-sk-ovm-class - "Insert a class definition" + "Insert a class definition." () > "class " (setq name (skeleton-read "Name: ")) " extends " (skeleton-read "Extends: ") ";" \n > _ \n @@ -14442,7 +14442,7 @@ See also `verilog-header' for an alternative format." > "endclass" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-uvm-object - "Insert a class definition" + "Insert a class definition." () > "class " (setq name (skeleton-read "Name: ")) " extends " (skeleton-read "Extends: ") ";" \n > _ \n @@ -14456,7 +14456,7 @@ See also `verilog-header' for an alternative format." > "endclass" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-uvm-component - "Insert a class definition" + "Insert a class definition." () > "class " (setq name (skeleton-read "Name: ")) " extends " (skeleton-read "Extends: ") ";" \n > _ \n @@ -14497,8 +14497,7 @@ See also `verilog-header' for an alternative format." > (- verilog-indent-level-behavioral) "endfunction" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-always - "Insert always block. Uses the minibuffer to prompt -for sensitivity list." + "Insert always block. Prompt for sensitivity list." () > "always @ ( /*AUTOSENSE*/ ) begin\n" > _ \n @@ -14513,14 +14512,14 @@ for sensitivity list." > (- verilog-indent-level-behavioral) "end" \n > ) (define-skeleton verilog-sk-specify - "Insert specify block. " + "Insert specify block." () > "specify\n" > _ \n > (- verilog-indent-level-behavioral) "endspecify" \n > ) (define-skeleton verilog-sk-generate - "Insert generate block. " + "Insert generate block." () > "generate\n" > _ \n diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 3fe67fabf19..fef7dff65e2 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -5985,13 +5985,11 @@ corresponding \"begin\" keyword, else return nil." (defconst vhdl-begin-fwd-re "\\b\\(is\\|begin\\|block\\|component\\|generate\\|then\\|else\\|loop\\|process\\|procedural\\(\\s-+body\\)?\\|units\\|use\\|record\\|protected\\(\\s-+body\\)?\\|for\\)\\b\\([^_]\\|\\'\\)" - "A regular expression for searching forward that matches all known -\"begin\" keywords.") + "Regexp for searching forward that matches all known \"begin\" keywords.") (defconst vhdl-begin-bwd-re "\\b\\(is\\|begin\\|block\\|component\\|generate\\|then\\|else\\|loop\\|process\\|procedural\\(\\s-+body\\)?\\|units\\|use\\|record\\|protected\\(\\s-+body\\)?\\|for\\)\\b[^_]" - "A regular expression for searching backward that matches all known -\"begin\" keywords.") + "Regexp for searching backward that matches all known \"begin\" keywords.") (defun vhdl-begin-p (&optional lim) "Return t if we are looking at a real \"begin\" keyword. @@ -6848,7 +6846,7 @@ keyword at PLACEHOLDER, then return the library unit type." )) (defun vhdl-get-block-state (&optional lim) - "Finds and records all the closest opens. + "Find and records all the closest opens. LIM is the furthest back we need to search (it should be the previous libunit keyword)." (let ((here (point)) @@ -7722,13 +7720,13 @@ indentation is done before aligning." (setq copy (cdr copy)))))))) (defun vhdl-align-region-2 (begin end match &optional substr spacing) - "Align a range of lines from BEGIN to END. The regular expression -MATCH must match exactly one field: the whitespace to be -contracted/expanded. The alignment column will equal the -rightmost column of the widest whitespace block. SPACING is -the amount of extra spaces to add to the calculated maximum required. -SPACING defaults to 1 so that at least one space is inserted after -the token in MATCH." + "Align a range of lines from BEGIN to END. +The regular expression MATCH must match exactly one field: the +whitespace to be contracted/expanded. The alignment column will +equal the rightmost column of the widest whitespace block. +SPACING is the amount of extra spaces to add to the calculated +maximum required. SPACING defaults to 1 so that at least one +space is inserted after the token in MATCH." (setq spacing (or spacing 1)) (setq substr (or substr 1)) (save-excursion @@ -7994,8 +7992,9 @@ the token in MATCH." (beginning-of-line 2)))))) (defun vhdl-align-inline-comment-region (beg end &optional spacing no-message) - "Align inline comments within a region. Groups of code lines separated by -empty lines are aligned individually, if `vhdl-align-groups' is non-nil." + "Align inline comments within a region. +Groups of code lines separated by empty lines are aligned +individually, if `vhdl-align-groups' is non-nil." (interactive "r\nP") (save-excursion (let (orig pos) @@ -8044,8 +8043,9 @@ empty lines are aligned individually, if `vhdl-align-groups' is non-nil." (message "Aligning inline comments...done")))) (defun vhdl-align-inline-comment-buffer () - "Align inline comments within buffer. Groups of code lines separated by -empty lines are aligned individually, if `vhdl-align-groups' is non-nil." + "Align inline comments within buffer. +Groups of code lines separated by empty lines are aligned +individually, if `vhdl-align-groups' is non-nil." (interactive) (vhdl-align-inline-comment-region (point-min) (point-max))) @@ -8053,9 +8053,10 @@ empty lines are aligned individually, if `vhdl-align-groups' is non-nil." ;; Fixup whitespace (defun vhdl-fixup-whitespace-region (beg end &optional no-message) - "Fixup whitespace in region. Surround operator symbols by one space, -eliminate multiple spaces (except at beginning of line), eliminate spaces at -end of line, do nothing in comments and strings." + "Fixup whitespace in region. +Surround operator symbols by one space, eliminate multiple +spaces (except at beginning of line), eliminate spaces at end of +line, do nothing in comments and strings." (interactive "r") (unless no-message (message "Fixing up whitespace...")) (save-excursion @@ -8107,9 +8108,10 @@ end of line, do nothing in comments and strings." (unless no-message (message "Fixing up whitespace...done"))) (defun vhdl-fixup-whitespace-buffer () - "Fixup whitespace in buffer. Surround operator symbols by one space, -eliminate multiple spaces (except at beginning of line), eliminate spaces at -end of line, do nothing in comments." + "Fixup whitespace in buffer. +Surround operator symbols by one space, eliminate multiple +spaces (except at beginning of line), eliminate spaces at end of +line, do nothing in comments." (interactive) (vhdl-fixup-whitespace-region (point-min) (point-max))) @@ -10456,8 +10458,8 @@ otherwise." reset)) (defun vhdl-template-standard-package (library package) - "Insert specification of a standard package. Include a library -specification, if not already there." + "Insert specification of a standard package. +Include a library specification, if not already there." (let ((margin (current-indentation))) (unless (equal library "std") (unless (or (save-excursion @@ -13175,7 +13177,7 @@ File statistics: \"%s\"\n\ "Regexp to match start of construct to hide.") (defun vhdl-hs-forward-sexp-func (count) - "Find end of construct to hide (for hideshow). Only searches forward." + "Find end of construct to hide (for hideshow). Only search forward." (let ((pos (point))) (vhdl-prepare-search-2 (beginning-of-line) @@ -13299,7 +13301,8 @@ File statistics: \"%s\"\n\ (goto-char end)))))) (defun vhdl-font-lock-match-item (limit) - "Match, and move over, any declaration item after point. Adapted from + "Match, and move over, any declaration item after point. +Adapted from `font-lock-match-c-style-declaration-item-and-skip-to-next'." (condition-case nil (save-restriction @@ -13750,8 +13753,7 @@ This does background highlighting of translate-off regions.") ;; Variables (defvar vhdl-entity-alist nil - "Cache with entities and corresponding architectures for each -project/directory.") + "Cache with entities and corresponding architectures for each project/directory.") ;; structure: (parenthesized expression means list of such entries) ;; (cache-key ;; (ent-key ent-name ent-file ent-line @@ -15019,8 +15021,7 @@ otherwise use cached data." (declare-function speedbar-goto-this-file "speedbar" (file)) (defun vhdl-speedbar-expand-dirs (_directory) - "Expand subdirectories in DIRECTORY according to - `speedbar-shown-directories'." + "Expand subdirectories in DIRECTORY according to `speedbar-shown-directories'." ;; (nicked from `speedbar-default-directory-list') (let ((sf (cdr (reverse speedbar-shown-directories))) (vhdl-speedbar-update-current-unit nil)) @@ -15836,7 +15837,7 @@ NO-POSITION non-nil means do not re-position cursor." (declare-function speedbar-line-text "speedbar" (&optional p)) (defun vhdl-speedbar-line-text () - "Calls `speedbar-line-text' and removes text properties." + "Call `speedbar-line-text' and remove text properties." (let ((string (speedbar-line-text))) (set-text-properties 0 (length string) nil string) string)) @@ -17074,8 +17075,7 @@ do not print any file names." (or project-options compiler-options))) (defun vhdl-compile () - "Compile current buffer using the VHDL compiler specified in -`vhdl-compiler'." + "Compile current buffer using the VHDL compiler specified in `vhdl-compiler'." (interactive) (vhdl-compile-init) (let* ((project (vhdl-aget vhdl-project-alist vhdl-project)) @@ -17852,8 +17852,7 @@ User Options `vhdl-indent-comment-like-next-code-line': (new) Specify whether comment lines are indented like following code line. `vhdl-array-index-record-field-in-sensitivity-list': (new) - Specify whether to include array indices / record fields in sensitivity list. -") + Specify whether to include array indices / record fields in sensitivity list.") (defconst vhdl-doc-keywords nil diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 0f7a5194977..ab7e8f6e29e 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -71,7 +71,7 @@ (require 'ring) (require 'project) -(defgroup xref nil "Cross-referencing commands" +(defgroup xref nil "Cross-referencing commands." :version "25.1" :group 'tools) @@ -247,7 +247,7 @@ generic functions.") The result must be a list of xref objects. If IDENTIFIER contains sufficient information to determine a unique definition, -return only that definition. If there are multiple possible +return only that definition. If there are multiple possible definitions, return all of them. If no definitions can be found, return nil. @@ -491,7 +491,7 @@ value." (goto-char pos)) (defun xref--goto-location (location) - "Set buffer and point according to xref-location LOCATION." + "Set buffer and point according to `xref-location' LOCATION." (let ((marker (xref-location-marker location))) (set-buffer (marker-buffer marker)) (xref--goto-char marker))) @@ -499,9 +499,9 @@ value." (defun xref-pop-to-location (item &optional action) "Go to the location of ITEM and display the buffer. ACTION controls how the buffer is displayed: - nil -- switch-to-buffer - `window' -- pop-to-buffer (other window) - `frame' -- pop-to-buffer (other frame) + nil -- `switch-to-buffer' + `window' -- `pop-to-buffer' (other window) + `frame' -- `pop-to-buffer' (other frame) If SELECT is non-nil, select the target window." (let* ((marker (save-excursion (xref-location-marker (xref-item-location item)))) @@ -962,7 +962,7 @@ The window showing the xref buffer will be selected." (put-text-property (+ pos xref-truncation-width) eol 'invisible 'ellipsis)))))) (defun xref--insert-xrefs (xref-alist) - "Insert XREF-ALIST in the current-buffer. + "Insert XREF-ALIST in the current buffer. XREF-ALIST is of the form ((GROUP . (XREF ...)) ...), where GROUP is a string for decoration purposes and XREF is an `xref-item' object." |