diff options
| author | Brian Paul <brian.paul@tungstengraphics.com> | 2006-09-21 22:54:53 +0000 |
|---|---|---|
| committer | Brian Paul <brian.paul@tungstengraphics.com> | 2006-09-21 22:54:53 +0000 |
| commit | 87c5ec817c02f497b5608b5756c207bb0c6b48ff (patch) | |
| tree | 688da43e4addea7cb8d0d7efee56cc310208ee63 /docs | |
| parent | bb0862968e1915852a011cd296ec6918b1142518 (diff) | |
updated doxygen info
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sourcedocs.html | 17 |
1 files 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 @@ <p> <A HREF="http://www.doxygen.org" target="_parent">Doxygen</A> 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. +</p> + +<p> +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 <code>doxygen</code> directory and run <code>make</code>. </P> +<p> +For an example of Doxygen usage in Mesa, see a recent source file +such as <a href="http://webcvs.freedesktop.org/mesa/Mesa/src/mesa/main/bufferobj.c?view=markup" target="_parent">bufferobj.c</a>. +</p> + + <P> If you're reading this page from your local copy of Mesa, and have run the doxygen scripts, you can read the documentation |