.. -*- coding: utf-8; mode: rst -*-
.. include:: refs.txt

.. _all-in-a-tumble-debug:

========================================
kernel-doc from ``all-in-a-tumble.[ch]``
========================================

Below you find the reST_ markup, generated from kernel-doc comments of the
example files :ref:`all-in-a-tumble.h-src` and :ref:`all-in-a-tumble.c-src`.
This markup will be produced by the kernel-doc parser and inserted in the
document by using the following directives:

.. code-block:: rst

   .. kernel-doc::  ./all-in-a-tumble.c
      :module: foo

   .. kernel-doc::  ./all-in-a-tumble.h
      :module: foo

The option ``:module:`` is optional, to find out why we use this option *here*,
see :ref:`kernel-doc-options`.

- :ref:`all-in-a-tumble.h-debug`
- :ref:`all-in-a-tumble.c-debug`

.. _all-in-a-tumble.h-debug:

kernel-doc from  ``all-in-a-tumble.h``
======================================

.. kernel-doc::  ./all-in-a-tumble.h
    :debug:
    :module: foo

.. _all-in-a-tumble.c-debug:

kernel-doc from  ``all-in-a-tumble.c``
======================================

.. kernel-doc::  ./all-in-a-tumble.c
    :debug:
    :module: foo