summaryrefslogtreecommitdiff
path: root/docs/sourcedocs.html
blob: 898ecac74c6138e4c70fa05a6241860198bd5e37 (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
38
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
  <meta http-equiv="content-type" content="text/html; charset=utf-8">
  <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://cgit.freedesktop.org/mesa/mesa/tree/src/mesa/main/bufferobj.c" 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>