some minor ui changes

[hbs.git] / bs / bsdoc.h

diff --git a/bs/bsdoc.h b/bs/bsdoc.h
index eac45f40432b1a62ee0865ba64d3a8961d07f9a0..3cca9c34290db51fdbe32578c210e48c21e44787 100644 (file)
--- a/bs/bsdoc.h
+++ b/bs/bsdoc.h
@@ -66,6 +66,13 @@ class BSDoc : public QObject
   protected:
     bool modified;
 
+       /**This is the main datastructure of the battlecalc, it's more or less the
+        * core that everything else works around. A short explanation of the fields:
+        * -# The name of the battle (usually coordinates)
+        * -# The name of the group (ie. Friendly/Hostile)
+        * -# The fleetname (Home Planet, coordinates, irc nicks and so on)
+        * - and in the end you got the actual Fleet object with it's data.
+        */
        std::map<QString, std::map<QString, std::map<QString, Fleet> > > m_Battles;
 };