Add docs to fix "M-x checkdoc" errors.
--- a/debian-doc.el Thu Jul 18 12:03:56 2013 +0300
+++ b/debian-doc.el Thu Jul 18 12:09:42 2013 +0300
@@ -1,6 +1,9 @@
+;;; debian-doc.el --- Debian doc-base integration with Emacs.
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;; Debian doc-base.
+;;; Commentary:
+;;
+
+;;; Code:
(defvar debian-doc-dir "/usr/share/doc-base")
(defvar debian-doc-buffer-name "*debian-doc*")
@@ -15,6 +18,7 @@
("^Document: \\(.*\\)" 1 font-lock-keyword-face)))
(defun debian-doc-mode ()
+ "Debian-Doc mode for viewing doc-base information."
(kill-all-local-variables)
(setq major-mode 'debian-doc-mode
mode-name "Debian-Doc")
@@ -24,6 +28,9 @@
(defvar debian-doc-completion-list nil)
(defun debian-doc (&optional prefix)
+ "Build Debian-Doc buffer.
+
+With PREFIX force to rebuild buffer from doc-base files."
(interactive "P")
(when prefix
(kill-buffer debian-doc-buffer))
@@ -46,6 +53,7 @@
(beginning-of-buffer)))
(defun debian-doc-visit ()
+ "Prompt for Debian package which represent docs and visit its entry in Debian-oc buffer."
(interactive)
(let (word start)
(debian-doc)
@@ -61,3 +69,7 @@
(recenter-top-bottom))))
(define-key debian-doc-mode-map (kbd "RET") 'debian-doc-visit-at-point)
+
+(provide 'debian-doc)
+
+;;; debian-doc.el ends here