X-Git-Url: https://ruin.nu/git/?a=blobdiff_plain;f=bs%2Fbsdoc.h;h=d113f5bc3df0effd22428ce91108654478778244;hb=56b09bf912d2965744e2e78a30fc68d73ebe401c;hp=eac45f40432b1a62ee0865ba64d3a8961d07f9a0;hpb=e07f49323a1936c90605d06f6f63e4c39b4c4aca;p=hbs.git

diff --git a/bs/bsdoc.h b/bs/bsdoc.h
index eac45f4..d113f5b 100644
--- a/bs/bsdoc.h
+++ b/bs/bsdoc.h
@@ -40,7 +40,7 @@ class BSDoc : public QObject
   Q_OBJECT
 
   public:
-    BSDoc();
+	BSDoc();
     ~BSDoc();
     void newDoc();
     bool save();
@@ -58,7 +58,7 @@ class BSDoc : public QObject
 	 * change it.
 	 * \todo remove this, and replace it with a better more closed interface.
 	 */
-	std::map<QString, std::map<QString, std::map<QString, Fleet> > >& Battles();
+	const std::map<QString, std::map<QString, std::map<QString, Fleet> > >& Battles() const;
 
   signals:
     void documentChanged();
@@ -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;
 };