Function: define-short-documentation-group

define-short-documentation-group is a macro defined in shortdoc.el.gz.

Signature

(define-short-documentation-group GROUP &rest FUNCTIONS)

Documentation

Add GROUP to the list of defined documentation groups.

FUNCTIONS is a list of elements on the form:

  (fun
   :no-manual BOOL
   :args ARGS
   :eval EXAMPLE-FORM
   :no-eval EXAMPLE-FORM
   :no-eval* EXAMPLE-FORM
   :no-value EXAMPLE-FORM
   :result RESULT-FORM
   :result-string RESULT-FORM
   :eg-result RESULT-FORM
   :eg-result-string RESULT-FORM)

BOOL should be non-nil if the function isn't documented in the manual.

ARGS is optional; the function's signature is displayed if ARGS is not present.

If EVAL isn't a string, it will be printed with prin1, and then evaluated to give a result, which is also printed. If it's a string, it'll be inserted as is, then the string will be read, and then evaluated.

There can be any number of :example/:result elements.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/shortdoc.el.gz
(defmacro define-short-documentation-group (group &rest functions)
  "Add GROUP to the list of defined documentation groups.
FUNCTIONS is a list of elements on the form:

  (fun
   :no-manual BOOL
   :args ARGS
   :eval EXAMPLE-FORM
   :no-eval EXAMPLE-FORM
   :no-eval* EXAMPLE-FORM
   :no-value EXAMPLE-FORM
   :result RESULT-FORM
   :result-string RESULT-FORM
   :eg-result RESULT-FORM
   :eg-result-string RESULT-FORM)

BOOL should be non-nil if the function isn't documented in the
manual.

ARGS is optional; the function's signature is displayed if ARGS
is not present.

If EVAL isn't a string, it will be printed with `prin1', and then
evaluated to give a result, which is also printed.  If it's a
string, it'll be inserted as is, then the string will be `read',
and then evaluated.

There can be any number of :example/:result elements."
  `(progn
     (setq shortdoc--groups (delq (assq ',group shortdoc--groups)
                                  shortdoc--groups))
     (push (cons ',group ',functions) shortdoc--groups)))