X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fsourcedocs.html;h=7bf5508f726a0466aa0488a808f913165db11fcb;hb=382776d2419ee55de50417c30ab8ebb7911a5f01;hp=898ecac74c6138e4c70fa05a6241860198bd5e37;hpb=297309ce2366dcc81df5403eb56547f1feedd0e0;p=mesa.git diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html index 898ecac74c6..7bf5508f726 100644 --- a/docs/sourcedocs.html +++ b/docs/sourcedocs.html @@ -2,15 +2,22 @@ - Source Code Documentation + Source Documentation -

Source Code Documentation

+
+ The Mesa 3D Graphics Library +
+ + +
+ +

Source 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.

+