X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fsourcedocs.html;h=ac6fffe18b672e60849f22f4cfe70a97986d989b;hb=9624855f13c20f28c198c4c5c53e78aff3492a6d;hp=90538af5cf0fb8a6cf03f3774593cc879d5ca169;hpb=87c5ec817c02f497b5608b5756c207bb0c6b48ff;p=mesa.git diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html index 90538af5cf0..ac6fffe18b6 100644 --- a/docs/sourcedocs.html +++ b/docs/sourcedocs.html @@ -1,15 +1,23 @@ - + + + + + Source Documentation + + + -Source Code Documentation +
+ The Mesa 3D Graphics Library +
- + +
- - -

Source Code Documentation

+

Source Documentation

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

@@ -17,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. +

- - +
+ +