; More minor stylistic fixes found by checkdoc

1 files changed, 32 insertions, 35 deletions

diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el
index fef7dff65e2..fc0d406f73c 100644
--- a/lisp/progmodes/vhdl-mode.el
+++ b/lisp/progmodes/vhdl-mode.el
@@ -2197,8 +2197,8 @@ is pair matching KEY."
 	(setq alist alist-cdr)))))
 
 (defun vhdl-aget (alist key)
-  "Return the value in ALIST that is associated with KEY.  If KEY is
-not found, then nil is returned."
+  "Return the value in ALIST that is associated with KEY.
+If KEY is not found, then nil is returned."
   (cdr (assoc key alist)))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -4275,8 +4275,7 @@ STRING are replaced by `-' and substrings are converted to lower case."
 (defvar vhdl-sources-menu nil)
 
 (defun vhdl-directory-files (directory &optional full match)
-  "Call `directory-files' if DIRECTORY exists, otherwise generate error
-message."
+  "Call `directory-files' if DIRECTORY exists, otherwise generate error message."
   (if (not (file-directory-p directory))
       (vhdl-warning-when-idle "No such directory: \"%s\"" directory)
     (let ((dir (directory-files directory full match)))
@@ -5734,8 +5733,8 @@ the offset is simply returned."
 	 (save-excursion (re-search-forward "\\\\" (vhdl-point 'eol) t)))))
 
 (defun vhdl-forward-comment (&optional direction)
-  "Skip all comments (including whitespace).  Skip backwards if DIRECTION is
-negative, skip forward otherwise."
+  "Skip all comments (including whitespace).
+Skip backwards if DIRECTION is negative, skip forward otherwise."
   (interactive "p")
   (if (and direction (< direction 0))
       ;; skip backwards
@@ -6912,9 +6911,9 @@ previous libunit keyword)."
   (concat vhdl-case-alternative-re "\\|" vhdl-case-header-key))
 
 (defun vhdl-skip-case-alternative (&optional lim)
-  "Skip forward over case/when bodies, with optional maximal
-limit.  If no next case alternative is found, nil is returned and
-point is not moved."
+  "Skip forward over case/when bodies, with optional maximal limit.
+If no next case alternative is found, nil is returned and point
+is not moved."
   (let ((lim (or lim (point-max)))
 	(here (point))
 	donep foundp)
@@ -6939,9 +6938,8 @@ point is not moved."
     foundp))
 
 (defun vhdl-backward-skip-label (&optional lim)
-  "Skip backward over a label, with optional maximal
-limit.  If label is not found, nil is returned and point
-is not moved."
+  "Skip backward over a label, with optional maximal limit.
+If label is not found, nil is returned and point is not moved."
   (let ((lim (or lim (point-min)))
 	placeholder)
     (if (save-excursion
@@ -6955,9 +6953,8 @@ is not moved."
     ))
 
 (defun vhdl-forward-skip-label (&optional lim)
-  "Skip forward over a label, with optional maximal
-limit.  If label is not found, nil is returned and point
-is not moved."
+  "Skip forward over a label, with optional maximal limit.
+If label is not found, nil is returned and point is not moved."
   (let ((lim (or lim (point-max))))
     (if (looking-at vhdl-label-key)
 	(progn
@@ -7327,9 +7324,9 @@ after the containing paren which starts the arglist."
       (- ce-curcol cs-curcol -1))))
 
 (defun vhdl-lineup-comment (_langelem)
-  "Support old behavior for comment indentation.  We look at
-vhdl-comment-only-line-offset to decide how to indent comment
-only-lines."
+  "Support old behavior for comment indentation.
+We look at `vhdl-comment-only-line-offset' to decide how to
+indent comment only-lines."
   (save-excursion
     (back-to-indentation)
     ;; at or to the right of comment-column
@@ -7445,7 +7442,7 @@ else indent `correctly'."
    (setq this-command 'vhdl-electric-tab)))
 
 (defun vhdl-electric-return ()
-  "newline-and-indent or indent-new-comment-line if in comment and preceding
+  "`newline-and-indent' or `indent-new-comment-line' if in comment and preceding
 character is a space."
   (interactive)
   (if (and (= (preceding-char) ? ) (vhdl-in-comment-p))
@@ -7456,8 +7453,8 @@ character is a space."
     (newline-and-indent)))
 
 (defun vhdl-indent-line ()
-  "Indent the current line as VHDL code.  Returns the amount of
-indentation change."
+  "Indent the current line as VHDL code.
+Return the amount of indentation change."
   (interactive)
   (let* ((syntax (and vhdl-indent-syntax-based (vhdl-get-syntactic-context)))
 	 (pos (- (point-max) (point)))
@@ -7617,8 +7614,8 @@ ALIGN-PATTERN matches the white space to be expanded/contracted.")
 ;; Align code
 
 (defvar vhdl-align-try-all-clauses t
-  "If REGEXP is not found on the first line of the region that clause
-is ignored.  If this variable is non-nil, then the clause is tried anyway.")
+  "If REGEXP is not found on the first line of the region that clause is ignored.
+If this variable is non-nil, then the clause is tried anyway.")
 
 (defun vhdl-do-group (function &optional spacing)
   "Apply FUNCTION on group of lines between empty lines."
@@ -7637,8 +7634,7 @@ is ignored.  If this variable is non-nil, then the clause is tried anyway.")
     (funcall function beg end spacing)))
 
 (defun vhdl-do-list (function &optional spacing)
-  "Apply FUNCTION to the lines of a list surrounded by a balanced group of
-parentheses."
+  "Apply FUNCTION to lines of a list surrounded by a balanced group of parentheses."
   (let (beg end)
     (save-excursion
       ;; search for beginning of balanced group of parentheses
@@ -7683,11 +7679,11 @@ parentheses."
     (funcall function beg end spacing)))
 
 (defun vhdl-align-region-1 (begin end &optional spacing alignment-list _indent)
-  "Attempt to align a range of lines based on the content of the
-lines.  The definition of `alignment-list' determines the matching
-order and the manner in which the lines are aligned.  If ALIGNMENT-LIST
-is not specified `vhdl-align-alist' is used.  If INDENT is non-nil,
-indentation is done before aligning."
+  "Attempt to align a range of lines based on the content of the lines.
+The definition of `alignment-list' determines the matching order
+and the manner in which the lines are aligned.  If ALIGNMENT-LIST
+is not specified `vhdl-align-alist' is used.  If INDENT is
+non-nil, indentation is done before aligning."
   (interactive "r\np")
   (setq alignment-list (or alignment-list vhdl-align-alist))
   (setq spacing (or spacing 1))
@@ -11070,7 +11066,7 @@ Point is left between them."
 ;; Help functions
 
 (defun vhdl-electric-space (count)
-  "Expand abbreviations and self-insert space(s), do indent-new-comment-line
+  "Expand abbreviations and self-insert space(s), do `indent-new-comment-line'
 if in comment and past end-comment-column."
   (interactive "p")
   (cond ((vhdl-in-comment-p)
@@ -11619,8 +11615,7 @@ but not if inside a comment or quote."
       string)))
 
 (defun vhdl-paste-group-comment (string indent)
-  "Paste comment and empty lines from STRING between groups of lines
-with INDENT."
+  "Paste comment and empty lines from STRING between groups of lines with INDENT."
   (let ((pos (point-marker)))
     (when (> indent 0)
       (while (string-match "^\\(--\\)" string)
@@ -14919,7 +14914,8 @@ if required."
       (setq project-alist (cdr project-alist)))))
 
 (defun vhdl-speedbar-insert-project-hierarchy (project indent &optional rescan)
-  "Insert hierarchy of PROJECT.  Rescan directories if RESCAN is non-nil,
+  "Insert hierarchy of PROJECT.
+Rescan directories if optional argument RESCAN is non-nil,
 otherwise use cached data."
   (when (or rescan (and (not (assoc project vhdl-file-alist))
 			(not (vhdl-load-cache project))))
@@ -14937,7 +14933,8 @@ otherwise use cached data."
   (vhdl-speedbar-expand-units project))
 
 (defun vhdl-speedbar-insert-dir-hierarchy (directory depth &optional rescan)
-  "Insert hierarchy of DIRECTORY.  Rescan directory if RESCAN is non-nil,
+  "Insert hierarchy of DIRECTORY.
+Rescan directory if optional argument RESCAN is non-nil,
 otherwise use cached data."
   (when (or rescan (and (not (assoc directory vhdl-file-alist))
 			(not (vhdl-load-cache directory))))