Add documentation checker for exported symbols

[clnl] / src / main / lex.lisp

diff --git a/src/main/lex.lisp b/src/main/lex.lisp
index b0ef2f1d1a591c8b6940093e09c83e52120fcdc5..d39ab5922e1545134b3eaaa262c41179b0eb4cc2 100644 (file)
--- a/src/main/lex.lisp
+++ b/src/main/lex.lisp
@@ -32,6 +32,20 @@
      *lexes*))))
 
 (defun lex (text)
+ "LEX TEXT => AST
+
+ARGUMENTS AND VALUES:
+
+  TEXT: Some NetLogo code
+  AST: An ambigious AST that can later be parsed
+
+DESCRIPTION:
+
+  LEX lexes NetLogo code.
+
+  LEX checks for some things, in as much as it can without knowing anything
+  about some of the backgrounds of NetLogo.  However, it does the first pass
+  with as much as it can."
  (if (string= "" text)
   (let
    ((lex (find-if (lambda (f) (funcall f *state* :eof)) *lexes* :from-end t :key #'car)))