Added comments

Jesper Torp Kristensen · Jesper Torp Kristensen · commit b8123df2c6c4 · 2012-08-27T20:17:07.000+02:00
diff --git a/src/endgames/endgame_piece_pos.hxx b/src/endgames/endgame_piece_pos.hxx
@@ -12,14 +12,18 @@
 bool piece_overlap(std::vector<PiecePos> pp);
 
 /**
- * TODO
+ * Sort the entries in the piece order KQRBNPkqrbnp
  */
-bool swap_piece_pos(std::vector<PiecePos> &pieces, bool symmetric_endgame_and_btm);
+void sort_piece_pos(std::vector<PiecePos> &pieces);
 
 /**
- * TODO
+ * pieces must already be sorted using the above function.
+ * This function rearranges the pieces to the order required by the endgame tables
+ * by possible swapping the order such that the black pieces are listed first.
+ * Returns true if a swap was made - in that case the endgame table must be
+ * indexed with the opposite color.
  */
-void sort_piece_pos(std::vector<PiecePos> &pieces);
+bool swap_piece_pos(std::vector<PiecePos> &pieces, bool symmetric_endgame_and_btm);
 
 /**
  * If endgame is KBKP, and bishop captured by pawn is being promoted to queen,
