[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    playground/games/bovo
From:       Aron Boström <c02ab () efd ! lth ! se>
Date:       2007-04-04 0:35:48
Message-ID: 1175646948.529993.5483.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 650162 by bostrom:

Started adding apidox comments to AI
 


 M  +4 -1      TODO  
 M  +44 -4     ai/aisquare.h  


--- trunk/playground/games/bovo/TODO #650161:650162
@@ -4,7 +4,10 @@
 log. We want collective code ownership.
 [ ] Undo moves.
 [ ] Hint moves.
-[ ] Documentation.
+     [ ] implement moves() in ai.
+[ ] Documentation/Handbook.
+     [ ] Game rules.
+     [ ] Game history.
 [ ] Apidox.
 [ ] Fully i18n.
 [ ] Code beautification.
--- trunk/playground/games/bovo/ai/aisquare.h #650161:650162
@@ -19,18 +19,58 @@
 *
 ********************************************************************/                \
  
+/** 
+ * @file Declares the square class used by the AI internally
+ */
+
 #ifndef AISQUARE_H
 #define AISQUARE_H
 
 #include "square.h"
 
+/** namespace for AI stuff */
 namespace ai {
-  class aisquare : public bovo::square {
-  public:
+
+/**
+ * aisquare is used by the AI to represent a square in a playing board.
+ *
+ * This class is used internally by the AI to represent a square in a 
+ * playing board. It extends the normal @c square class with possibilities
+ * to keep a point attached to the square, as well as a bool marker that
+ * tells whether this square needs a recalculation of its points.
+ *
+ * Examples construction: (create a playing board)
+ * @code
+ * aisquare** board = new aisquare*[width];
+ * for (int x = 0; x < width; ++x) {
+ *     board[x] = new aisquare[height];
+ * }
+ * @endcode
+ * 
+ * Example point use:
+ * @code
+ * board[x][y].point = point;
+ * @endcode
+ *
+ * @author bostrom (Aron Boström) <aron bostrom gmail com>
+ */
+class aisquare : public bovo::square {
+public:
+    /**
+     * @brief a game square in the AI
+     * @description this class extends the ordinary game square with the addition of \
a point attribute and a bool attribute, for AI purposes +     * @param
+     * @return
+     * @exception
+     * @see
+     * @author
+     * @since
+     */
     aisquare();
     unsigned long int point;
     bool grey;
-  };
-}
+};
 
+} // namespace ai
+
 #endif


[prev in list] [next in list] [prev in thread] [next in thread]