Update the Doxygen mainpage to show an example of how to make a page for a PolyVox tutorial.
This commit is contained in:
parent
8f4b18bf03
commit
997bef28db
@ -1,11 +1,28 @@
|
|||||||
/**
|
/**
|
||||||
\mainpage PolyVox Framework
|
\mainpage PolyVox Framework
|
||||||
|
|
||||||
The PolyVox documentation.
|
The PolyVox documentation.\n
|
||||||
|
|
||||||
|
For a brief introduction, see the \ref tutorial.
|
||||||
|
|
||||||
|
|
||||||
\par
|
|
||||||
\author David Williams
|
\author David Williams
|
||||||
|
|
||||||
\namespace PolyVox
|
\namespace PolyVox
|
||||||
\brief Main namespace
|
\brief Main namespace
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
\page tutorial Tutorial
|
||||||
|
|
||||||
|
This is a basic tutorial covering the essentials of using PolyVox.
|
||||||
|
|
||||||
|
\code
|
||||||
|
#include <Block.h>
|
||||||
|
|
||||||
|
int main(int argc, char *argv[])
|
||||||
|
{
|
||||||
|
//blah blah
|
||||||
|
}
|
||||||
|
\endcode
|
||||||
|
*/
|
||||||
|
Loading…
x
Reference in New Issue
Block a user