projects / mesa.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
panfrost: Identify shared tiler structure
[mesa.git] / docs / sourcedocs.html
diff --git a/docs/sourcedocs.html b/docs/sourcedocs.html
index a5248d988d72fa1bb3e085a53489823c75b354cd..7bf5508f726a0466aa0488a808f913165db11fcb 100644 (file)
--- a/docs/sourcedocs.html
+++ b/docs/sourcedocs.html
@@ -1,26 +1,51 @@
-<HTML>
+<!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 Documentation</title>
+  <link rel="stylesheet" type="text/css" href="mesa.css">
+</head>
+<body>
 
 
-<TITLE>Source Code Documentation</TITLE>
+<div class="header">
+  The Mesa 3D Graphics Library
+</div>
 
 
-<link rel="stylesheet" type="text/css" href="mesa.css"></head>
+<iframe src="contents.html"></iframe>
+<div class="content">
 
 
-<BODY>
-
-<H1>Source Code Documentation</H1>
+<h1>Source Documentation</h1>
 
 <p>
 
 <p>
-<A HREF="http://www.doxygen.org" target="_parent">Doxygen</A>
+<a href="http://www.doxygen.nl">Doxygen</a>
 is used to automatically
 is used to automatically
-produce cross-referenced documentation from the Mesa sources.
-This is not included in the normal Mesa distribution.
-Download Mesa from CVS if interested.
+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 git, change to
+the <code>doxygen</code> directory and run <code>make</code>.
 </P>
 
 </P>
 
-<P>
+<p>
+For an example of Doxygen usage in Mesa, see a recent source file
+such as <a href="https://gitlab.freedesktop.org/mesa/mesa/blob/master/src/mesa/main/bufferobj.c">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
 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>
+<a href="../doxygen/main/index.html">here</a>
+</p>
+
+<p>
+Gallium is also documented using Sphinx. The generated output can be found
+<a href="https://gallium.readthedocs.io">on Gallium.ReadTheDocs.io</a>.
+</p>
 
 
-</BODY>
-</HTML>
+</div>
+</body>
+</html>