From db1b93498d264f567fc78d054093540d09598bc2 Mon Sep 17 00:00:00 2001
From: terrorfisch <humsim@t-online.de>
Date: Fri, 10 Oct 2014 00:15:01 +0200
Subject: [PATCH] Added comment.

---
 apps/openmw/mwmechanics/aistate.hpp | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/apps/openmw/mwmechanics/aistate.hpp b/apps/openmw/mwmechanics/aistate.hpp
index 6616beb1f..3e72d013f 100644
--- a/apps/openmw/mwmechanics/aistate.hpp
+++ b/apps/openmw/mwmechanics/aistate.hpp
@@ -112,13 +112,19 @@ public:
 
 namespace MWMechanics
 {
-    /// \brief base class for the temporary storage of AiPackages
+    /// \brief base class for the temporary storage of AiPackages.
+    /**
+     * Each AI package with temporary values needs a AiPackageStorage class
+     * which is derived from AiTemporaryBase. The CharacterController holds a container
+     * AiState where one of these storages can be stored at a time.
+     * The execute(...) member function takes this container as an argument.
+     * */
     struct AiTemporaryBase
     {
         virtual ~AiTemporaryBase(){};
     };
     
-    /// \brief Container for AI package status
+    /// \brief Container for AI package status.
     typedef DerivedClassStorage<AiTemporaryBase> AiState;
 }