2003-03-08 17:38:57 +00:00
|
|
|
<HTML>
|
|
|
|
|
|
|
|
|
|
<TITLE>Source Code Documentation</TITLE>
|
|
|
|
|
|
2005-01-20 03:55:10 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="mesa.css"></head>
|
|
|
|
|
|
|
|
|
|
<BODY>
|
2003-03-08 17:38:57 +00:00
|
|
|
|
|
|
|
|
<H1>Source Code Documentation</H1>
|
|
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
