Add documentation checker for exported symbols

[clnl] / src / main / main.lisp

diff --git a/src/main/main.lisp b/src/main/main.lisp
index 8304d0f1432f2c85324dac1e02052fc4b8aad153..749c765949ce775f3aa7d99d3d9f9c372d564e50 100644 (file)
--- a/src/main/main.lisp
+++ b/src/main/main.lisp
@@ -15,6 +15,15 @@
 (defun p (result) result)
 
 (defun run ()
+ "RUN => RESULT
+
+ARGUMENTS AND VALUES:
+
+  RESULT: undefined, the system terminates at the end of the loop
+
+DESCRIPTION:
+
+  RUN implements a very simple REPL."
  (loop
   :for str := (progn (format t "> ") (force-output) (read-line))
   :while str
@@ -22,11 +31,43 @@
  (sb-ext:exit))
 
 (defun boot ()
+ "BOOT => RESULT
+
+ARGUMENTS AND VALUES:
+
+  RESULT: undefined
+
+DESCRIPTION:
+
+  BOOT does exactly that, boots the clnl system in a clean state.  The seed
+  is set so that multiple runs will evaluate to the same."
  (clnl-random:set-seed 15)
  (clnl-nvm:create-world))
 
 (defun run-commands (cmds)
+ "RUN-COMMANDS CMDS => RESULT
+
+ARGUMENTS AND VALUES:
+
+  CMDS: A string that may have one more NetLogo commands
+  RESULT: undefined
+
+DESCRIPTION:
+
+  RUN-COMMANDS will take NetLogo commands, put them through the various
+  stages need to turn them into Common Lisp code, and run it."
  (eval (clnl-transpiler:transpile-commands (clnl-parser:parse (clnl-lexer:lex cmds)))))
 
 (defun run-reporter (reporter)
+ "RUN-REPORTER REPORTER => RESULT
+
+ARGUMENTS AND VALUES:
+
+  REPORTER: A string that should have only one reporter
+  RESULT: The value reported by the NVM
+
+DESCRIPTION:
+
+  RUN-REPORTER will take a NetLogo REPORTER, put it through the various
+  stages need to turn them into Common Lisp code, run it, and return the RESULT."
  (eval (clnl-transpiler:transpile-reporter (car (clnl-parser:parse (clnl-lexer:lex reporter))))))