(comment-normalize-vars): Add docstring.

diff --git a/lisp/newcomment.el b/lisp/newcomment.el
index 6874da7b4e554d87000c88f72135f1e774a7851f..6b6f2d0b0e8eb23166013c61702cd488423e1eba 100644 (file)
--- 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)