aboutsummaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorcolin <colin@cicadas.surf>2024-05-11 13:10:04 -0700
committercolin <colin@cicadas.surf>2024-05-11 13:10:04 -0700
commitc48361bb23ec21c672096104d6885c87f5ecbef6 (patch)
treeb22444e8ac1c9481407a67e0965e9d5f8b007c14 /examples
parent2dc174bf4960f413dfb0a051eb446c167984c546 (diff)
Update: README. Add: print-all-route-documentation
Diffstat (limited to 'examples')
-rw-r--r--examples/dice-roller.lisp2
-rw-r--r--examples/kitchensink.lisp6
2 files changed, 5 insertions, 3 deletions
diff --git a/examples/dice-roller.lisp b/examples/dice-roller.lisp
index d87faf4..465d252 100644
--- a/examples/dice-roller.lisp
+++ b/examples/dice-roller.lisp
@@ -20,7 +20,7 @@
:initform (wknd:slot-required 'roller 'rolls)
:type integer
:documentation "The number of sides"))
- (:documentation "")
+ (:documentation "Rolls a virtual dices with SIDES sides ROLLS number of times.")
(:metaclass wknd::endpoint)
(:method . :get)
(:route-parts "roll" +digits+ "d" +digits+)
diff --git a/examples/kitchensink.lisp b/examples/kitchensink.lisp
index 00a7f25..7fcf45b 100644
--- a/examples/kitchensink.lisp
+++ b/examples/kitchensink.lisp
@@ -54,7 +54,8 @@
(defclass hello ()
()
- (:documentation "A Page that just says hello.")
+ (:documentation "A Page that just says hello to an identified user. Redirects users to
+identify themselves if no name is known.")
(:metaclass wknd:endpoint)
(:method . :get)
(:route-parts "hello")
@@ -74,7 +75,8 @@
((name :reader name :initarg :name :type string))
(:metaclass wknd::endpoint)
(:method . :post)
- (:route-parts "identify"))
+ (:route-parts "identify")
+ (:documentation "Endpoint for identifying oneself."))
(defmethod wknd::handle ((req identify))
(wknd:set-cookie "name" :value (name req))