summaryrefslogtreecommitdiff
path: root/lisp/newcomment.el
diff options
context:
space:
mode:
authorStefan Monnier <monnier@iro.umontreal.ca>2003-05-06 14:55:56 +0000
committerStefan Monnier <monnier@iro.umontreal.ca>2003-05-06 14:55:56 +0000
commit0f21c5a0a61c36dc39fcd78b7dbe1a10a8880b11 (patch)
treefb603beb1c4c200f0f7a9d86cc77ff1768073140 /lisp/newcomment.el
parent6b09e9c8dad9bd63af0a1bc78f390fce5daaad5f (diff)
downloademacs-0f21c5a0a61c36dc39fcd78b7dbe1a10a8880b11.tar.gz
(comment-normalize-vars): Add docstring.
Diffstat (limited to 'lisp/newcomment.el')
-rw-r--r--lisp/newcomment.el4
1 files changed, 4 insertions, 0 deletions
diff --git a/lisp/newcomment.el b/lisp/newcomment.el
index 6874da7b4e5..6b6f2d0b0e8 100644
--- a/lisp/newcomment.el
+++ b/lisp/newcomment.el
@@ -211,6 +211,10 @@ This is obsolete because you might as well use \\[newline-and-indent]."
;;;###autoload
(defun comment-normalize-vars (&optional noerror)
+ "Check and setup the variables needed by other commenting functions.
+Functions autoloaded from newcomment.el, being entry points, should call
+this function before any other, so the rest of the code can assume that
+the variables are properly set."
(if (not comment-start)
(unless noerror
(set (make-local-variable 'comment-start)