af9b073d5f
The separate readthedocs documentation is quite pointless these days, as it's been moved to docs.mesa3d.org, where all other documentation already is. There's nothing special about this documentation any longer. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6893>
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>`__
|