aboutsummaryrefslogtreecommitdiff
path: root/mesalib/docs/sourcedocs.html
diff options
context:
space:
mode:
authormarha <marha@users.sourceforge.net>2009-10-09 06:31:44 +0000
committermarha <marha@users.sourceforge.net>2009-10-09 06:31:44 +0000
commit06456f5db88b434c3634ede42bdbfdce78fc4249 (patch)
tree97f5174e2d3da40faee7f2ad8858233da3d0166e /mesalib/docs/sourcedocs.html
parent7b230a3fe2d6c83488d9eec43067fe8ba8ac081b (diff)
parenta0c4815433ccd57322f4f7703ca35e9ccfa59250 (diff)
downloadvcxsrv-06456f5db88b434c3634ede42bdbfdce78fc4249.tar.gz
vcxsrv-06456f5db88b434c3634ede42bdbfdce78fc4249.tar.bz2
vcxsrv-06456f5db88b434c3634ede42bdbfdce78fc4249.zip
svn merge ^/branches/released . --username marha
Diffstat (limited to 'mesalib/docs/sourcedocs.html')
-rw-r--r--mesalib/docs/sourcedocs.html37
1 files changed, 37 insertions, 0 deletions
diff --git a/mesalib/docs/sourcedocs.html b/mesalib/docs/sourcedocs.html
new file mode 100644
index 000000000..90538af5c
--- /dev/null
+++ b/mesalib/docs/sourcedocs.html
@@ -0,0 +1,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>