Changeset 65 in tspsg-svn for trunk/src/tspsolver.cpp

Timestamp:

Oct 20, 2009, 9:38:01 PM (15 years ago)

Author:

laleppa

Message:

More code documentation.

File:

• trunk/src/tspsolver.cpp (modified) (5 diffs)

trunk/src/tspsolver.cpp

@@ -24 +24 @@
 #include "tspsolver.h"
 
+//! Class constructor
 CTSPSolver::CTSPSolver()
         : nCities(0)
@@ -125 +126 @@
 }
 
-// TODO: Comment the algorithm
+/*!
+ * \brief Solves the given task.
+ * \param numCities Number of cities in the task.
+ * \param task The matrix of city-to-city travel costs.
+ * \param parent The parent widget for displaying messages and dialogs.
+ *
+ * \todo TODO: Comment the algorithm.
+ */
 sStep *CTSPSolver::solve(int numCities, tMatrix task, QWidget *parent)
 {
@@ -226 +234 @@
 }
 
+/*!
+ * \brief Returns the sorted optimal path, starting from City 1.
+ */
 QString CTSPSolver::getSortedPath() const
 {
@@ -242 +253 @@
 }
 
+/*!
+ * \brief Returns CTSPSolver's version ID.
+ *
+ *  Current version ID is <b>\$Id$</b>.
+ */
 QString CTSPSolver::getVersionId()
 {
@@ -247 +263 @@
 }
 
+/*!
+ * \brief Returns whether or not the solution is definitely optimal.
+ *
+ *  The solution may need some further interations to determine whether it is optimal.
+ *  In such cases this function returns \p false.
+ */
 bool CTSPSolver::isOptimal() const
 {