From 5260cb2d161eb4a2eb175fced4a4afa8c0f85648 Mon Sep 17 00:00:00 2001 From: Marc Zinnschlag Date: Sat, 25 Sep 2010 15:03:53 +0200 Subject: [PATCH] first set of additional doxygen comments --- apps/doc.hpp | 3 +++ apps/openmw/doc.hpp | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 apps/doc.hpp create mode 100644 apps/openmw/doc.hpp diff --git a/apps/doc.hpp b/apps/doc.hpp new file mode 100644 index 0000000000..e7fb1fa411 --- /dev/null +++ b/apps/doc.hpp @@ -0,0 +1,3 @@ +// Note: This is not a regular source file. + +/// \defgroup apps Applications diff --git a/apps/openmw/doc.hpp b/apps/openmw/doc.hpp new file mode 100644 index 0000000000..978f0f5fb2 --- /dev/null +++ b/apps/openmw/doc.hpp @@ -0,0 +1,44 @@ +// Note: This is not a regular source file. + +/// \ingroup apps +/// \defgroup openmw OpenMW + +/// \namespace OMW +/// \ingroup openmw +/// \brief Integration of OpenMW-subsystems + +/// \namespace MWDialogue +/// \ingroup openmw +/// \brief NPC dialogues + +/// \namespace MWMechanics +/// \ingroup openmw +/// \brief Game mechanics and NPC-AI + +/// \namespace MWSound +/// \ingroup openmw +/// \brief Sound & music + +/// \namespace MWGUI +/// \ingroup openmw +/// \brief HUD and windows + +/// \namespace MWRender +/// \ingroup openmw +/// \brief Rendering via Ogre + +/// \namespace MWWorld +/// \ingroup openmw +/// \brief World data + +/// \namespace MWClass +/// \ingroup openmw +/// \brief Workaround for non-OOP design of the record system + +/// \namespace MWInput +/// \ingroup openmw +/// \brief User input and character controls + +/// \namespace MWScript +/// \ingroup openmw +/// \brief MW-specific script extentions and integration of the script system into OpenMW