Corrected and improved comments

5 files changed, 22 insertions, 21 deletions

diff --git a/backtrack.h b/backtrack.h
index d1048b8..92ff688 100644
--- a/backtrack.h
+++ b/backtrack.h
@@ -3,7 +3,7 @@
  *
  * See the README file for copyright information and how to reach the author.
  *
- * $Id: backtrack.h 14 2005-10-29 14:08:06Z tom $
+ * $Id: backtrack.h 18 2005-11-03 21:48:08Z tom $
  */
 
 #ifndef VDR_SUDOKU_BACKTRACK_H
@@ -121,7 +121,7 @@ namespace BackTrack
     /** Find the next valid solution to the problem.
      *
      * Repeated calls will find all solutions to a problem if multiple solutions
-     * exist. Return true if a solution was found.
+     * exist.
      */
     void find_next_solution();
 
diff --git a/setup.cpp b/setup.cpp
index d708e82..c610b61 100644
--- a/setup.cpp
+++ b/setup.cpp
@@ -3,7 +3,7 @@
  *
  * See the README file for copyright information and how to reach the author.
  *
- * $Id: setup.cpp 17 2005-11-03 21:42:11Z tom $
+ * $Id: setup.cpp 19 2005-11-03 21:54:19Z tom $
  */
 
 #include "setup.h"
@@ -17,7 +17,7 @@ using namespace SudokuPlugin;
 
 /** Constructor
  *
- * Initialize the parameters of the plugin with standard values.
+ * Initialize the setup parameters of the plugin with standard values.
  */
 SetupData::SetupData()
 {
@@ -29,9 +29,9 @@ SetupData::SetupData()
   transparency = 50;
 }
 
-/** Parse the parameters of the plugin.
+/** Parse the setup parameters of the plugin.
  *
- * This method is called for each parameter the plugin has previously
+ * This method is called for each setup parameter the plugin has previously
  * stored in the global setup data.
  */
 bool SetupData::parse(const char* name, const char* value)
@@ -69,9 +69,10 @@ SetupPage::SetupPage(SetupData& setup) :
   Add(new cMenuEditIntItem(tr("Transparency (%)"), &data.transparency, 0, 100));
 }
 
-/** Store the parameters of the plugin.
+/** Store the setup parameters of the plugin.
  *
- * The parameters of the plugin are stored into the global setup data file.
+ * The setup parameters of the plugin are stored into the global setup data
+ * file.
  */
 void SetupPage::Store()
 {
diff --git a/setup.h b/setup.h
index 8fec17a..d04c09e 100644
--- a/setup.h
+++ b/setup.h
@@ -3,7 +3,7 @@
  *
  * See the README file for copyright information and how to reach the author.
  *
- * $Id: setup.h 16 2005-10-31 21:12:41Z tom $
+ * $Id: setup.h 19 2005-11-03 21:54:19Z tom $
  */
 
 #ifndef VDR_SUDOKU_SETUP_H
@@ -32,14 +32,14 @@ namespace SudokuPlugin
     /** Constructor */
     SetupData();
 
-    /** Parse the parameters of the plugin. */
+    /** Parse the setup parameters of the plugin. */
     bool parse(const char* name, const char* value);
   };
 
 
   //--- class SudokuPlugin::SetupPage ------------------------------------------
 
-  /** Setup menu page to adjust the parameters of the plugin */
+  /** Setup menu page to adjust the setup parameters of the plugin */
   class SetupPage : public cMenuSetupPage
   {
     SetupData& setup;
@@ -52,7 +52,7 @@ namespace SudokuPlugin
 
   protected:
 
-    /** Store the parameters of the plugin. */
+    /** Store the setup parameters of the plugin. */
     virtual void Store();
   };
 
diff --git a/solver.h b/solver.h
index 65cf87e..4bb4fa6 100644
--- a/solver.h
+++ b/solver.h
@@ -3,7 +3,7 @@
  *
  * See the README file for copyright information and how to reach the author.
  *
- * $Id: solver.h 11 2005-10-28 01:00:01Z tom $
+ * $Id: solver.h 18 2005-11-03 21:48:08Z tom $
  */
 
 #ifndef VDR_SUDOKU_SOLVER_H
@@ -59,12 +59,12 @@ namespace Sudoku
    *    \code
    *    Puzzle puzzle; // Generate an empty puzzle without givens.
    *    Solver solver(puzzle);
-   *    solver.find_next_solution(true);
+   *    solver.find_next_solution();
    *    while (solver.solution_is_valid())
    *    {
    *      // Do something with the puzzle.
    *      ...
-   *      solver.find_next_solution(true);
+   *      solver.find_next_solution();
    *    }
    *    \endcode
    */
diff --git a/sudoku.cpp b/sudoku.cpp
index 1c9ab86..5f7c0cd 100644
--- a/sudoku.cpp
+++ b/sudoku.cpp
@@ -3,7 +3,7 @@
  *
  * See the README file for copyright information and how to reach the author.
  *
- * $Id: sudoku.cpp 11 2005-10-28 01:00:01Z tom $
+ * $Id: sudoku.cpp 18 2005-11-03 21:48:08Z tom $
  */
 
 #include "sudoku.h"
@@ -55,10 +55,10 @@ namespace SudokuPlugin
     /** OSD object that shows the plugin's main menu */
     virtual cOsdObject* MainMenuAction();
 
-    /** Setup menu page to adjust the parameters of the plugin */
+    /** Setup menu page to adjust the setup parameters of the plugin */
     virtual cMenuSetupPage* SetupMenu();
 
-    /** Parse the parameters of the plugin. */
+    /** Parse the setup parameters of the plugin. */
     virtual bool SetupParse(const char* name, const char* value);
   };
 
@@ -91,7 +91,7 @@ cOsdObject* Plugin::MainMenuAction()
   return new Menu(setup, puzzle, curr);
 }
 
-/** Setup menu page to adjust the parameters of the plugin
+/** Setup menu page to adjust the setup parameters of the plugin
  *
  * This method is called every time the plugin's setup menu entry is selected.
  */
@@ -100,9 +100,9 @@ cMenuSetupPage* Plugin::SetupMenu()
   return new SetupPage(setup);
 }
 
-/** Parse the parameters of the plugin.
+/** Parse the setup parameters of the plugin.
  *
- * This method is called for each parameter the plugin has previously
+ * This method is called for each setup parameter the plugin has previously
  * stored in the global setup data.
  */
 bool Plugin::SetupParse(const char* name, const char* value)