mangos-mirror/server
0
0
Fork 0
mirror of https://github.com/mangosfour/server.git synced 2025-12-13 13:37:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Sync] Some project sync

Browse source
This commit is contained in:
Antz 2014-10-13 15:25:39 +01:00 • committed by Antz
parent b25fa433fe
commit bbf0020c1a
98 changed files with 5866 additions and 2121 deletions
Download patch file Download diff file Expand all files Collapse all files

63
doc/DocStructure.dox
View file

@ -3,12 +3,63 @@
* \section intro_sec Introduction and links
* This is the source documentation for the \b %MaNGOS (Massive Network Game %Object Server) project.\n
* %MaNGOS is an object-oriented Massively Multiplayer Online Role-Playing Game Server (MMORPGS).\n
* The project documentation and the bug tracker can be found on the <A HREF="http://getmangos.co.uk/wiki">%MaNGOS wiki</A>.
* The project documentation can be found on the <A HREF="http://github.com/mangoswiki/wiki">%MaNGOS wiki</A>.
* The project bug tracker can be found on the <A HREF="http://getmangos.eu">%MaNGOS website</A>.
*
* \section begin Where to begin?
* If you are interested in understanding the source code of this project you can begin
* - <A HREF="http://getmangos.co.uk/wiki/">On the wiki</A> to get an overview of the different modules of the server
* - <A HREF="http://getmangos.eu/wiki/">On the wiki</A> to get an overview of the different modules of the server
* - <A HREF="./modules.html">In this source doumentation</A>, starting at the module hierarchy
*
* \section conventions Naming/Coding conventions
* When using a singleton to access something a define along the following lines is often used:
* \code{.cpp}
* #define sAuctionBot MaNGOS::Singleton<AuctionHouseBot>::Instance()
* \endcode
* Notice the small s prepending the variable name, this is important and is used often throughout
* the source. When using a pointer is it often prepended with a small p, ie:
* \code{.cpp}
* OneClass* pOneClass = NULL;
* \endcode
*
* Member variables in a class are prepended with m_VarName, functions are name with CamelCase but with
* a capital first letter. Indentation is done as follows:
* \code{.cpp}
* class MyNiceClass
* {
* public:
* MyNiceClass();
* virtual ~MyNiceClass();
*
* void Function();
* private:
* uint32 m_CoolStuff;
* AnotherClass* m_pOtherClass;
* };
*
* MyNiceClass::MyNiceClass()
* {}
*
* void MyNiceClass::Function()
* {
* if(m_CoolStuff == 10)
* exit(EXIT_SUCCESS);
* else
* {
* std::cout << "Cool stuff" << std::endl;
* }
* }
* \endcode
*
* When working with iterators and loops in general always use the prefix ++ or -- operator as it's
* faster, ie:
* \code{.cpp}
* for (std::list<std::string>::const_iterator it = list.begin(); it != list.end(); ++it);
* \endcode
*
*
* \todo Move the naming conventions to their own file when it's finished
* \todo Add more examples of how the code should look, there was an example in the Wiki before
*/
/*! \defgroup realmd Realm Daemon
@ -28,3 +79,11 @@
/*! \defgroup world The World
\ingroup mangos
*/
/*! \defgroup auctionhouse The Auction House
\ingroup mangos
*/
/*! \defgroup auctionbot The Auction House Bot
\ingroup auctionhouse
*/