Skip to content

Instantly share code, notes, and snippets.

@psilord
Created February 22, 2026 22:19
Show Gist options
  • Select an option

  • Save psilord/76ad96464418e6bc0778c48d1ee897eb to your computer and use it in GitHub Desktop.

Select an option

Save psilord/76ad96464418e6bc0778c48d1ee897eb to your computer and use it in GitHub Desktop.
(docentry xxx-0 (:function)
(synopsis "This is one line that describes the function.")
(arguments
(a "Describe arg a")
(b "Describe arg b"))
(return-values
(value "value 1 desc")
(value "value 2 desc")
(value "value N desc"))
(description
(p "This is the rest of the function docstring, including other DSL
formatting stuff. There is a lot more here and it could be a markup DSL
too if desired as well. This text is always whitespace reformatted and
relayed out in accordance to the display.")
(ul (li "some" "forms")
(li "some" "more" "forms")
(li "and" "some" "more"))
(p "More description stuff.")
(dl (dt "thing")
(dd "description of thing")
(dt "stuff")
(dd "description of stuff")))
(example
(defun doit ()
(format t "The sum of 10 and 20 is: ~A~%" (xxx-0 10 20))))
(see-also
(xxx-0 :compiler-macro)))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment