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

CLOS Class
----------

Documentation for CLOS Classes is configured like

.. rst:directive:: .. cl:clos-class:: symbol-name

   The ``:cl:clos-class:`` directive emits Common Lisp Object System (CLOS) class documentation::

       .. cl:clos-class:: example-class

   The ``:noinitargs:`` option can be specified to exclude the class' list of ``:initarg``
   initialzers that are ordinarily included in the class' signature::

       .. cl:clos-class:: example-class
          :noinitargs:


   Note: There is no mechanism or directive to document individual slots at the moment.

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

  (defclass example-class ()
    ((slot1 :initarg :slot1 :accessor slot1
            :initform "default"
            :documentation "the first slot.")
     (slot2 :initarg :slot2 :accessor slot2
            :documentation "the second slot."))
    (:documentation "An example class."))

Output
~~~~~~
.. cl:clos-class:: example-class

Code
~~~~

.. code-block:: common-lisp

  (define-condition example-error (simple-error)
      ((message
        :initarg :message
        :accessor error-message
        :initform nil
        :documentation "Message indicating what went wrong."))
    (:documentation "An example condition"))

Output
~~~~~~

.. cl:clos-class:: example-error