1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html lang="en">
3<head>
4  <meta http-equiv="content-type" content="text/html; charset=utf-8">
5  <title>Source Code Documentation</title>
6  <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
8<body>
9
10<h1>Source Code Documentation</h1>
11
12<p>
13<a href="http://www.doxygen.org" target="_parent">Doxygen</a>
14is used to automatically
15produce cross-referenced documentation from the Mesa source code.
16</p>
17
18<p>
19The Doxygen configuration files and generated files are not included
20in the normal Mesa distribution (they're very large).
21To generate Doxygen documentation, download Mesa from CVS, change to
22the <code>doxygen</code> directory and run <code>make</code>.
23</P>
24
25<p>
26For an example of Doxygen usage in Mesa, see a recent source file
27such as <a href="http://cgit.freedesktop.org/mesa/mesa/tree/src/mesa/main/bufferobj.c" target="_parent">bufferobj.c</a>.
28</p>
29
30
31<p>
32If you're reading this page from your local copy of Mesa, and have
33run the doxygen scripts, you can read the documentation
34<a href="../doxygen/main/index.html" target="_parent">here</a>
35</p>
36
37</body>
38</html>
39