2012-06-12 08:05:03 +01:00
|
|
|
<!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>
|
2003-03-08 17:38:57 +00:00
|
|
|
|
2012-06-12 08:05:03 +01:00
|
|
|
<h1>Source Code Documentation</h1>
|
2003-03-08 17:38:57 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
<A HREF="http://www.doxygen.org" target="_parent">Doxygen</A>
|
|
|
|
is used to automatically
|
2006-09-21 23:54:53 +01:00
|
|
|
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>.
|
2003-03-08 17:38:57 +00:00
|
|
|
</P>
|
|
|
|
|
2006-09-21 23:54:53 +01:00
|
|
|
<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>
|
|
|
|
|
|
|
|
|
2003-03-08 17:38:57 +00:00
|
|
|
<P>
|
|
|
|
If you're reading this page from your local copy of Mesa, and have
|
|
|
|
run the doxygen scripts, you can read the documentation
|
2004-05-21 15:48:58 +01:00
|
|
|
<A HREF="../doxygen/main/index.html" target="_parent">here</A>
|
2003-03-08 17:38:57 +00:00
|
|
|
</P>
|
|
|
|
|
2012-06-12 08:05:03 +01:00
|
|
|
</body>
|
|
|
|
</html>
|