| Andreas Boll | ecd5c7c | 2012-06-12 09:05:03 +0200 | [diff] [blame] | 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"> |
| Erik Faye-Lund | 6e0e550 | 2019-05-06 13:13:11 +0200 | [diff] [blame] | 5 | <title>Source Documentation</title> |
| Andreas Boll | ecd5c7c | 2012-06-12 09:05:03 +0200 | [diff] [blame] | 6 | <link rel="stylesheet" type="text/css" href="mesa.css"> |
| 7 | </head> |
| 8 | <body> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 9 | |
| Andreas Boll | b5da52a | 2012-09-18 18:57:02 +0200 | [diff] [blame] | 10 | <div class="header"> |
| Erik Faye-Lund | ecdab0d | 2019-05-06 13:26:47 +0200 | [diff] [blame] | 11 | The Mesa 3D Graphics Library |
| Andreas Boll | b5da52a | 2012-09-18 18:57:02 +0200 | [diff] [blame] | 12 | </div> |
| 13 | |
| 14 | <iframe src="contents.html"></iframe> |
| 15 | <div class="content"> |
| 16 | |
| Erik Faye-Lund | 6e0e550 | 2019-05-06 13:13:11 +0200 | [diff] [blame] | 17 | <h1>Source Documentation</h1> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 18 | |
| 19 | <p> |
| Erik Faye-Lund | c59c793 | 2019-06-03 19:23:07 +0200 | [diff] [blame] | 20 | <a href="http://www.doxygen.nl">Doxygen</a> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 21 | is used to automatically |
| Brian Paul | 87c5ec8 | 2006-09-21 22:54:53 +0000 | [diff] [blame] | 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). |
| Andreas Boll | dbbe108 | 2013-01-30 22:35:35 +0100 | [diff] [blame] | 28 | To generate Doxygen documentation, download Mesa from git, change to |
| Brian Paul | 87c5ec8 | 2006-09-21 22:54:53 +0000 | [diff] [blame] | 29 | the <code>doxygen</code> directory and run <code>make</code>. |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 30 | </P> |
| 31 | |
| Brian Paul | 87c5ec8 | 2006-09-21 22:54:53 +0000 | [diff] [blame] | 32 | <p> |
| 33 | For an example of Doxygen usage in Mesa, see a recent source file |
| Eric Engestrom | ae2694e | 2018-09-21 14:39:53 +0100 | [diff] [blame] | 34 | such as <a href="https://gitlab.freedesktop.org/mesa/mesa/blob/master/src/mesa/main/bufferobj.c">bufferobj.c</a>. |
| Brian Paul | 87c5ec8 | 2006-09-21 22:54:53 +0000 | [diff] [blame] | 35 | </p> |
| 36 | |
| 37 | |
| Andreas Boll | 210a27d | 2012-06-12 09:05:36 +0200 | [diff] [blame] | 38 | <p> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 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 |
| Andreas Boll | a73c59b | 2012-09-18 19:31:28 +0200 | [diff] [blame] | 41 | <a href="../doxygen/main/index.html">here</a> |
| Andreas Boll | 210a27d | 2012-06-12 09:05:36 +0200 | [diff] [blame] | 42 | </p> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 43 | |
| Eric Engestrom | b347bbb | 2017-02-14 21:18:52 +0000 | [diff] [blame] | 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 | |
| Andreas Boll | b5da52a | 2012-09-18 18:57:02 +0200 | [diff] [blame] | 49 | </div> |
| Andreas Boll | ecd5c7c | 2012-06-12 09:05:03 +0200 | [diff] [blame] | 50 | </body> |
| 51 | </html> |