summaryrefslogtreecommitdiff
path: root/docs/sourcedocs.html
blob: 90538af5cf0fb8a6cf03f3774593cc879d5ca169 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<HTML>

<TITLE>Source Code Documentation</TITLE>

<link rel="stylesheet" type="text/css" href="mesa.css"></head>

<BODY>

<H1>Source Code Documentation</H1>

<p>
<A HREF="http://www.doxygen.org" target="_parent">Doxygen</A>
is used to automatically
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
<A HREF="../doxygen/main/index.html" target="_parent">here</A>
</P>

</BODY>
</HTML>