changeset 50845:ac2120f868b9

(comment-normalize-vars): Add docstring.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Tue, 06 May 2003 14:55:56 +0000
parents 86903fed9f75
children 1ac6f8245bff
files lisp/newcomment.el
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/newcomment.el	Tue May 06 14:29:39 2003 +0000
+++ b/lisp/newcomment.el	Tue May 06 14:55:56 2003 +0000
@@ -211,6 +211,10 @@
 
 ;;;###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)