classify-symbol.lisp

(docentry classify-symbol (:function)
  (synopsis "This is one line that describes the function.")
  (arguments
   (a "Describe arg a") ; args conspire to be in package of symbol
   (b "Describe arg b"))
  (returns
   (value "value 1 desc")
   (value "value 2 desc")
   (value "value N desc"))
  (side-effects "None.")
  (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")))
  ;; TODO: Can't do (examples ....) yet because it'll read the example
  ;; code in the wrong package. Leave that for later.
  (sources bib-bookfoo)
  (see-also index-0)

  ;; Any used index symbol not in the local index is checked for in the
  ;; dui global index, and if not there becomes a broken ref.
  (index ;; local-index symbol-macro-like replacement
   (index-0 (classify-symbol:xxx-0 :compiler-macro))))