X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsourcedocs.html;h=90538af5cf0fb8a6cf03f3774593cc879d5ca169;hb=e6ff995d14085caa447c4e8634bf069c8a94f0ec;hp=0bee7e37a7ec5c723ecd6856a3aef598bdf901a0;hpb=1d91a0b9086452472dc7c336add6305d16415ae7;p=mesa.git diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html index 0bee7e37a7e..90538af5cf0 100644 --- a/docs/sourcedocs.html +++ b/docs/sourcedocs.html @@ -2,22 +2,35 @@ Source Code Documentation - + + +

Source Code Documentation

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 CVS, 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