| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 1 | <HTML> |
| 2 | |
| 3 | <TITLE>Source Code Documentation</TITLE> |
| 4 | |
| Brian Paul | 36da045 | 2005-01-20 03:55:10 +0000 | [diff] [blame] | 5 | <link rel="stylesheet" type="text/css" href="mesa.css"></head> |
| 6 | |
| 7 | <BODY> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 8 | |
| 9 | <H1>Source Code Documentation</H1> |
| 10 | |
| 11 | <p> |
| 12 | <A HREF="http://www.doxygen.org" target="_parent">Doxygen</A> |
| 13 | is used to automatically |
| Brian Paul | 87c5ec8 | 2006-09-21 22:54:53 +0000 | [diff] [blame] | 14 | produce cross-referenced documentation from the Mesa source code. |
| 15 | </p> |
| 16 | |
| 17 | <p> |
| 18 | The Doxygen configuration files and generated files are not included |
| 19 | in the normal Mesa distribution (they're very large). |
| 20 | To generate Doxygen documentation, download Mesa from CVS, change to |
| 21 | the <code>doxygen</code> directory and run <code>make</code>. |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 22 | </P> |
| 23 | |
| Brian Paul | 87c5ec8 | 2006-09-21 22:54:53 +0000 | [diff] [blame] | 24 | <p> |
| 25 | For an example of Doxygen usage in Mesa, see a recent source file |
| 26 | such as <a href="http://webcvs.freedesktop.org/mesa/Mesa/src/mesa/main/bufferobj.c?view=markup" target="_parent">bufferobj.c</a>. |
| 27 | </p> |
| 28 | |
| 29 | |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 30 | <P> |
| 31 | If you're reading this page from your local copy of Mesa, and have |
| 32 | run the doxygen scripts, you can read the documentation |
| Brian Paul | 254d519 | 2004-05-21 14:48:58 +0000 | [diff] [blame] | 33 | <A HREF="../doxygen/main/index.html" target="_parent">here</A> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 34 | </P> |
| 35 | |
| 36 | </BODY> |
| 37 | </HTML> |