sourcedocs.html revision 87c5ec817c02f497b5608b5756c207bb0c6b48ff 
1<HTML>
2
3<TITLE>Source Code Documentation</TITLE>
4
5<link rel="stylesheet" type="text/css" href="mesa.css"></head>
6
7<BODY>
8
9<H1>Source Code Documentation</H1>
10
11<p>
12<A HREF="http://www.doxygen.org" target="_parent">Doxygen</A>
13is used to automatically
14produce cross-referenced documentation from the Mesa source code.
15</p>
16
17<p>
18The Doxygen configuration files and generated files are not included
19in the normal Mesa distribution (they're very large).
20To generate Doxygen documentation, download Mesa from CVS, change to
21the <code>doxygen</code> directory and run <code>make</code>.
22</P>
23
24<p>
25For an example of Doxygen usage in Mesa, see a recent source file
26such as <a href="http://webcvs.freedesktop.org/mesa/Mesa/src/mesa/main/bufferobj.c?view=markup" target="_parent">bufferobj.c</a>.
27</p>
28
29
30<P>
31If you're reading this page from your local copy of Mesa, and have
32run the doxygen scripts, you can read the documentation
33<A HREF="/doxygen/main/index.html" target="_parent">here</A>
34</P>
35
36</BODY>
37</HTML>
38