Functions

.. cl:function:: symbol-name

Outputs the function’s signature (arguments):

.. cl:function:: example-function

Code

(defun example-function (arg1 arg2 &optional (arg3 #'sort) &key (kw *example-variable*))
  "The CL Domain will try and convert any uppercase symbols into
reference for example EXAMPLE-FUNCTION, EXAMPLE-GENERIC or a hyperspec
link LIST.  Any unmatched symbols are converted to literals as is
ARG1, ARG2 and ARG3.  Explicit package references will also help
resolve symbol sources COMMON-LISP:CAR.  Keywords are also detected
for example :KEYWORD."
  (list arg1 arg2 arg3))

Output

Function (example-function arg1 arg2 &optional (arg3 #'sort) &key (kw *example-variable*))

(setf (example-function arg1 arg2) value)

The CL Domain will try and convert any uppercase symbols into reference for example EXAMPLE-FUNCTION, EXAMPLE-GENERIC or a hyperspec link LIST. Any unmatched symbols are converted to literals as is ARG1, ARG2 and ARG3. Explicit package references will also help resolve symbol sources CAR. Keywords are also detected for example :KEYWORD.

Macros

.. cl:macro:: symbol-name

Emit the macro’s signature and documentation:

.. cl:macro:: example-macro

Code

(defmacro example-macro ((arg1 arg2) &body arg3)
  "The CL Domain will try and convert any uppercase symbols into
reference for example EXAMPLE-FUNCTION or a hyperspec link LIST.  Any
unmatched symbols are converted to literals as is ARG1, ARG2 and ARG3.
Explicit package references will also help resolve symbol sources
COMMON-LISP:CDR.  Keywords are also detected for example :TEST."
  arg3)

Output

Macro (example-macro (arg1 arg2) &body arg3)

The CL Domain will try and convert any uppercase symbols into reference for example EXAMPLE-FUNCTION or a hyperspec link LIST. Any unmatched symbols are converted to literals as is ARG1, ARG2 and ARG3. Explicit package references will also help resolve symbol sources CDR. Keywords are also detected for example :TEST.