From 997bef28db8b5e8eee357f0a823b7f1ba1be6605 Mon Sep 17 00:00:00 2001 From: Matt Williams Date: Sun, 15 Mar 2009 19:28:20 +0000 Subject: [PATCH] Update the Doxygen mainpage to show an example of how to make a page for a PolyVox tutorial. --- library/Mainpage.dox | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/library/Mainpage.dox b/library/Mainpage.dox index 193f3164..47e67028 100644 --- a/library/Mainpage.dox +++ b/library/Mainpage.dox @@ -1,11 +1,28 @@ /** \mainpage PolyVox Framework -The PolyVox documentation. +The PolyVox documentation.\n + +For a brief introduction, see the \ref tutorial. + -\par \author David Williams \namespace PolyVox \brief Main namespace -*/ \ No newline at end of file +*/ + +/** +\page tutorial Tutorial + +This is a basic tutorial covering the essentials of using PolyVox. + +\code +#include + +int main(int argc, char *argv[]) +{ + //blah blah +} +\endcode +*/