Add docs to functions to 100% satisfy checkdoc.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Wed, 23 Mar 2016 11:25:11 +0200
changeset 380 f0e2c538bf85
parent 379 c336b3ebd9df
child 381 1729e4655e4d
Add docs to functions to 100% satisfy checkdoc.
contrib/gadict.el
--- a/contrib/gadict.el	Wed Mar 23 10:58:30 2016 +0200
+++ b/contrib/gadict.el	Wed Mar 23 11:25:11 2016 +0200
@@ -29,6 +29,7 @@
      ("^\\(?:n\\|v\\|phr\\.v\\|adj\\|adv\\|pron\\|prep\\|num\\|conj\\|int\\)$" . font-lock-type-face) ))
 
 (defun gadict-setup-fontlock ()
+  "Setup gadict fontlock."
   (setq font-lock-defaults
         '(gadict-font-lock-keywords
           t nil nil nil
@@ -36,6 +37,7 @@
   (add-hook 'font-lock-extend-region-functions 'gadict-font-lock-extend-region t) )
 
 (defun gadict-setup-comment ()
+  "Setup gadict comment commands."
   (set (make-local-variable 'comment-start)  "#")
   (set (make-local-variable 'comment-continue)  nil)
   (set (make-local-variable 'comment-end)  "")
@@ -44,16 +46,20 @@
   (set (make-local-variable 'comment-use-syntax)  nil) )
 
 (defun gadict-setup-paragraph ()
+  "Setup gadict paragraph definition."
   (set (make-local-variable 'paragraph-separate)  "__$")
   (set (make-local-variable 'paragraph-start)  "__$") )
 
 (defun gadict-setup-page ()
+  "Setup gadict page definition."
   (set (make-local-variable 'page-delimiter)  "__$") )
 
 (defun gadict-setup-syntax ()
+  "Setup gadict characters syntax."
   (modify-syntax-entry ?' "w"))
 
 (defun gadict-mark-article ()
+  "Mark current article."
   (end-of-line)
   (re-search-backward "^__$")
   (set-mark (point))
@@ -95,7 +101,7 @@
 (put 'gadict-tr 'safe-local-variable 'string-or-null-p)
 
 (defun gadict-new-entry ()
-  "Insert new entry template."
+  "Insert new article template."
   (interactive)
   (if (re-search-forward "^__" nil t)
       (beginning-of-line)
@@ -116,6 +122,7 @@
   (backward-char))
 
 (defun gadict-setup-keymap ()
+  "Setup gadict keymap."
   (define-key gadict-mode-map [C-return] 'gadict-new-entry))
 
 ;;;###autoload