docs/sourcedocs.html

   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 Documentation</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   The Mesa 3D Graphics Library
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Source Documentation</h1>
  18
  19 <p>
  20 <a href="http://www.doxygen.nl">Doxygen</a>
  21 is used to automatically
  22 produce cross-referenced documentation from the Mesa source code.
  23 </p>
  24
  25 <p>
  26 The Doxygen configuration files and generated files are not included
  27 in the normal Mesa distribution (they're very large).
  28 To generate Doxygen documentation, download Mesa from git, change to
  29 the <code>doxygen</code> directory and run <code>make</code>.
  30 </P>
  31
  32 <p>
  33 For an example of Doxygen usage in Mesa, see a recent source file
  34 such as <a href="https://gitlab.freedesktop.org/mesa/mesa/-/blob/master/src/mesa/main/bufferobj.c">bufferobj.c</a>.
  35 </p>
  36
  37
  38 <p>
  39 If you're reading this page from your local copy of Mesa, and have
  40 run the doxygen scripts, you can read the documentation
  41 <a href="../doxygen/main/index.html">here</a>
  42 </p>
  43
  44 <p>
  45 Gallium is also documented using Sphinx. The generated output can be found
  46 <a href="https://gallium.readthedocs.io">on Gallium.ReadTheDocs.io</a>.
  47 </p>
  48
  49 </div>
  50 </body>
  51 </html>