Add documentation for all the exported symbols

[candle] / src / main / run.lisp

diff --git a/src/main/run.lisp b/src/main/run.lisp
index d6b963c3a039ba097c012d9b50bd817fcab7c22e..d9797350547fe8403e6f0679435fe6383f644487 100644 (file)
--- a/src/main/run.lisp
+++ b/src/main/run.lisp
@@ -11,6 +11,16 @@
   (format t "~c[1;31m- ~:(~A~) Failed!~c[0m~%" #\Esc (getf task :name) #\Esc)))
 
 (defun run ()
+ "RUN => RESULT
+
+ARGUMENTS AND VALUES:
+
+  RESULT: a boolean, whether the process was successful
+
+DESCRIPTION:
+
+  Runs the script specified by the .candle file in the current directory.
+  When completed, the boolean will be returned if it was successful or not."
  (if
   (not (probe-file ".candle"))
   :dot-candle-absent