sourcedocs.rst 744 Bytes
Newer Older
1 2 3 4 5 6 7 8
Source Documentation
====================

`Doxygen <http://www.doxygen.nl>`__ is used to automatically produce
cross-referenced documentation from the Mesa source code.

The Doxygen configuration files and generated files are not included in
the normal Mesa distribution (they're very large). To generate Doxygen
Erik Faye-Lund 's avatar
Erik Faye-Lund committed
9
documentation, download Mesa from Git, change to the ``doxygen``
10 11 12 13 14 15 16 17 18
directory and run ``make``.

For an example of Doxygen usage in Mesa, see a recent source file such
as
`bufferobj.c <https://gitlab.freedesktop.org/mesa/mesa/-/blob/master/src/mesa/main/bufferobj.c>`__.

If you're reading this page from your local copy of Mesa, and have run
the doxygen scripts, you can read the documentation
`here <../doxygen/main/index.html>`__