mirror of
https://gitlab.freedesktop.org/mesa/mesa.git
synced 2024-12-01 06:04:12 +08:00
4d066836e3
This uses the previously added scripts to convert the documentation to reStructuredText, which is both easier to read offline, and can be used to generate modern HTML for online documentation. No modification to the generated results have been done. Acked-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
22 lines
884 B
ReStructuredText
22 lines
884 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>`__
|
|
|
|
Gallium is also documented using Sphinx. The generated output can be
|
|
found `on Gallium.ReadTheDocs.io <https://gallium.readthedocs.io>`__.
|