users-guide.h

Go to the documentation of this file.
00001 /*
00002  * users-guide.h
00003  *
00004  * Bogus header file for doxygen documentation.
00005  *
00006  * Don't use this file!
00007  */
00008 
00009 ////////////////////////////////////////////////////////////////////////////////
00010 ///
00011 /// \ingroup aesop
00012 /// \defgroup users_guide AESOP User's Guide
00013 ///
00014 /// This guide is for Users that want to play games built on the AESOP
00015 /// framework.
00016 ///
00017 /// \n
00018 /// <b>Target Audience:</b> People who are playing games built with the AESOP
00019 ///     framework.
00020 ///
00021 /// <b>Purpose of this User's Guide:</b> To help users generally, and to act as
00022 ///     an example or template for people writing user's guides specific to
00023 ///     their games.
00024 ///
00025 /// \n
00026 /// This documentation is intended for end users of the AESOP framework.  That
00027 /// is, the people who will actually play the games and participate in the
00028 /// stories that have been built.
00029 ///
00030 /// We expect that anyone building a game will provide their own documentation.
00031 /// This is provided as a generic guide and a starting point for storytellers
00032 /// who are creating their own user documentation.
00033 ///
00034 ////////////////////////////////////////////////////////////////////////////////