[colobot] 144/377: Add commments in CBot.h

[Didier Raboud]

This is an automated email from the git hooks/post-receive script.

odyx pushed a commit to branch debian/master
in repository colobot.

commit 0f491ce433e39b49e329f5920779a5e50950e1e4
Author: Grunaka <dev at romainbreton.fr>
Date:   Sun Dec 6 15:05:22 2015 +0100

    Add commments in CBot.h
---
 src/CBot/CBot.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/CBot/CBot.h b/src/CBot/CBot.h
index 1159518..4ba45b0 100644
--- a/src/CBot/CBot.h
+++ b/src/CBot/CBot.h
@@ -17,6 +17,12 @@
  * along with this program. If not, see http://gnu.org/licenses
  */
 
+/*!
+ * \file CBot.h
+ * \brief Public interface of CBot language interpreter. CBot.h is the only file
+ * that should be included by any Colobot files outside of the CBot module.
+ */
+
 // Modules inlcude
 #include "CBot/CBotFileUtils.h"
 #include "CBot/CBotClass.h"

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/colobot.git