From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Tue, 6 May 2003 14:55:56 +0000 (+0000)
Subject: (comment-normalize-vars): Add docstring.
X-Git-Tag: ttn-vms-21-2-B4~10296
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0f21c5a0a61c36dc39fcd78b7dbe1a10a8880b11;p=emacs.git

(comment-normalize-vars): Add docstring.
---

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)