.. cl:package:: sphinxcontrib.cldomain.doc

Functions
---------

.. rst:directive:: .. cl:function:: symbol-name

   Outputs the function's signature (arguments)::

       .. cl:function:: example-function

.. _hyperspec_example:

Code
~~~~

.. code-block:: common-lisp

  (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
~~~~~~
.. cl:function:: example-function


Macros
------

.. rst:directive:: .. cl:macro:: symbol-name

   Emit the macro's signature and documentation::

       .. cl:macro:: example-macro


Code
~~~~
.. code-block:: common-lisp

   (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
~~~~~~
.. cl:macro:: example-macro