From 87c5ec817c02f497b5608b5756c207bb0c6b48ff Mon Sep 17 00:00:00 2001 From: Brian Paul Date: Thu, 21 Sep 2006 22:54:53 +0000 Subject: [PATCH] updated doxygen info --- docs/sourcedocs.html | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html index a5248d988d7..90538af5cf0 100644 --- a/docs/sourcedocs.html +++ b/docs/sourcedocs.html @@ -11,11 +11,22 @@

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 -- 2.30.2