hmz007
36ed224bac
Signed-off-by: hmz007 <hmz007@gmail.com> Change-Id: Ib87fdbe7a0be7dc961af3500fe9ea4589a127f9f
19 lines
744 B
ReStructuredText
19 lines
744 B
ReStructuredText
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
|
|
documentation, download Mesa from Git, change to the ``doxygen``
|
|
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>`__
|