Add commments in CBot.h

2015-12-06 15:05:22 +01:00 · 2015-12-06 15:05:22 +01:00 · 0f491ce433
parent f9ab37fd14
commit 0f491ce433
1 changed files with 6 additions and 0 deletions
--- 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"