Skip to content
Browse files

`checkdoc' nits (including the `checkdoc-autoload' extension).

Remaining issues:

 - The docstrings for three "electric" functions don't explain what
   the prefix argument means.

 - `yaml-set-imenu-generic-expression' needs a docstring.
  • Loading branch information...
1 parent 9d5a888 commit cf171f43f7eb0eda628543dba34d610c90de83a5 @SamB committed Sep 1, 2012
Showing with 8 additions and 6 deletions.
  1. +8 −6 yaml-mode.el
View
14 yaml-mode.el
@@ -63,6 +63,7 @@
;; User definable variables
+;;;###autoload
(defgroup yaml nil
"Support for the YAML serialization format"
:group 'languages
@@ -79,7 +80,8 @@
:group 'yaml)
(defcustom yaml-backspace-function 'backward-delete-char-untabify
- "*Function called by `yaml-electric-backspace' when deleting backwards."
+ "*Function called by `yaml-electric-backspace' when deleting backwards.
+It will receive one argument, the numeric prefix value."
:type 'function
:group 'yaml)
@@ -113,7 +115,7 @@ that key is pressed to begin a block literal."
;; Constants
-(defconst yaml-mode-version "0.0.7" "Version of `yaml-mode.'")
+(defconst yaml-mode-version "0.0.7" "Version of `yaml-mode'.")
(defconst yaml-blank-line-re "^ *$"
"Regexp matching a line containing only (valid) whitespace.")
@@ -160,12 +162,12 @@ that key is pressed to begin a block literal."
(concat yaml-scalar-context-re
"\\(?:" yaml-tag-re "\\)?"
yaml-block-literal-base-re)
- "Regexp matching a line beginning a YAML block literal")
+ "Regexp matching a line beginning a YAML block literal.")
(defconst yaml-nested-sequence-re
(concat "^\\(?: *- +\\)+"
"\\(?:" yaml-bare-scalar-re " *:\\(?: +.*\\)?\\)?$")
- "Regexp matching a line containing one or more nested YAML sequences")
+ "Regexp matching a line containing one or more nested YAML sequences.")
(defconst yaml-constant-scalars-re
(concat "\\(?:^\\|\\(?::\\|-\\|,\\|{\\|\\[\\) +\\) *"
@@ -178,7 +180,7 @@ that key is pressed to begin a block literal."
"true" "True" "TRUE" "false" "False" "FALSE"
"on" "On" "ON" "off" "Off" "OFF") t)
" *$")
- "Regexp matching certain scalar constants in scalar context")
+ "Regexp matching certain scalar constants in scalar context.")
;; Mode setup
@@ -196,7 +198,7 @@ that key is pressed to begin a block literal."
(define-key yaml-mode-map "\C-j" 'newline-and-indent))
(defvar yaml-mode-syntax-table nil
- "Syntax table in use in yaml-mode buffers.")
+ "Syntax table in use in `yaml-mode' buffers.")
(if yaml-mode-syntax-table
nil
(setq yaml-mode-syntax-table (make-syntax-table))

0 comments on commit cf171f4

Please sign in to comment.
Something went wrong with that request. Please try again.