1848b8605Smrg<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2848b8605Smrg<html lang="en"> 3848b8605Smrg<head> 4848b8605Smrg <meta http-equiv="content-type" content="text/html; charset=utf-8"> 5848b8605Smrg <title>Source Code Documentation</title> 6848b8605Smrg <link rel="stylesheet" type="text/css" href="mesa.css"> 7848b8605Smrg</head> 8848b8605Smrg<body> 9848b8605Smrg 10848b8605Smrg<div class="header"> 11848b8605Smrg <h1>The Mesa 3D Graphics Library</h1> 12848b8605Smrg</div> 13848b8605Smrg 14848b8605Smrg<iframe src="contents.html"></iframe> 15848b8605Smrg<div class="content"> 16848b8605Smrg 17848b8605Smrg<h1>Source Code Documentation</h1> 18848b8605Smrg 19848b8605Smrg<p> 20848b8605Smrg<a href="http://www.doxygen.org">Doxygen</a> 21848b8605Smrgis used to automatically 22848b8605Smrgproduce cross-referenced documentation from the Mesa source code. 23848b8605Smrg</p> 24848b8605Smrg 25848b8605Smrg<p> 26848b8605SmrgThe Doxygen configuration files and generated files are not included 27848b8605Smrgin the normal Mesa distribution (they're very large). 28848b8605SmrgTo generate Doxygen documentation, download Mesa from git, change to 29848b8605Smrgthe <code>doxygen</code> directory and run <code>make</code>. 30848b8605Smrg</P> 31848b8605Smrg 32848b8605Smrg<p> 33848b8605SmrgFor an example of Doxygen usage in Mesa, see a recent source file 34b8e80941Smrgsuch as <a href="https://gitlab.freedesktop.org/mesa/mesa/blob/master/src/mesa/main/bufferobj.c">bufferobj.c</a>. 35848b8605Smrg</p> 36848b8605Smrg 37848b8605Smrg 38848b8605Smrg<p> 39848b8605SmrgIf you're reading this page from your local copy of Mesa, and have 40848b8605Smrgrun the doxygen scripts, you can read the documentation 41848b8605Smrg<a href="../doxygen/main/index.html">here</a> 42848b8605Smrg</p> 43848b8605Smrg 44b8e80941Smrg<p> 45b8e80941SmrgGallium is also documented using Sphinx. The generated output can be found 46b8e80941Smrg<a href="https://gallium.readthedocs.io">on Gallium.ReadTheDocs.io</a>. 47b8e80941Smrg</p> 48b8e80941Smrg 49848b8605Smrg</div> 50848b8605Smrg</body> 51848b8605Smrg</html> 52