X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fsourcedocs.html;h=660dcb2ef0eba3f3c061222683626ece79edd2fa;hb=93200ea26d42664006b1e63382f0b5db1c657384;hp=e8434baaf1f250d7f7c31632f01b9cbb4e5281ba;hpb=ecd5c7ceb8e4c8841b2708e5ab7efa145583f8c2;p=mesa.git diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html index e8434baaf1f..660dcb2ef0e 100644 --- a/docs/sourcedocs.html +++ b/docs/sourcedocs.html @@ -7,10 +7,17 @@ +
+

The Mesa 3D Graphics Library

+
+ + +
+

Source Code Documentation

-Doxygen +Doxygen is used to automatically produce cross-referenced documentation from the Mesa source code.

@@ -18,21 +25,27 @@ 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 CVS, change to +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. +such as 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 -

+here +

+ +

+Gallium is also documented using Sphinx. The generated output can be found +on Gallium.ReadTheDocs.io. +

+