X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fsourcedocs.html;h=0a0080dc64af4a83e2db4083af8c3b10764ae420;hb=934792b846b1e3a4d11792c950a525b434795892;hp=21032fe7ba579fe39e8e49d76ee576a7e9584dd9;hpb=0b27aceae2464db3dd149cf4fd667e353a655c5e;p=mesa.git diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html index 21032fe7ba5..0a0080dc64a 100644 --- a/docs/sourcedocs.html +++ b/docs/sourcedocs.html @@ -1,24 +1,46 @@ - + + + + + Source Code Documentation + + + -Source Code Documentation +
+

The Mesa 3D Graphics Library

+
- + +
-

Source Code Documentation

+

Source Code Documentation

-Doxygen +Doxygen is used to automatically -produce cross-referenced documentation from the Mesa sources. -This is not included in the normal Mesa distribution. -Download Mesa from CVS if interested. +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. +

+ + +

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 +

- - +
+ +