Changeset 85ad815b0b in tspsg for src/tspsolver.cpp

Timestamp:

Oct 21, 2009, 2:48:49 PM (15 years ago)

Author:

Oleksii Serdiuk

Branches:

0.1.3.145-beta1-symbian, 0.1.4.170-beta2-bb10, appveyor, imgbot, master, readme

Children:

e0fcac5f2c

Parents:

caef58b531

Message:

Some documentation updates.

File:

• src/tspsolver.cpp (modified) (4 diffs)

src/tspsolver.cpp

@@ -131 +131 @@
  * \param task The matrix of city-to-city travel costs.
  * \param parent The parent widget for displaying messages and dialogs.
+ * \return Pointer to the root of the solution tree.
  *
  * \todo TODO: Comment the algorithm.
@@ -236 +237 @@
 /*!
  * \brief Returns the sorted optimal path, starting from City 1.
+ * \return A string, containing sorted optimal path.
  */
 QString CTSPSolver::getSortedPath() const
@@ -255 +257 @@
 /*!
  * \brief Returns CTSPSolver's version ID.
- *
- *  Current version ID is <b>\$Id$</b>.
+ * \return A string: <b>\$Id$</b>.
  */
 QString CTSPSolver::getVersionId()
@@ -265 +266 @@
 /*!
  * \brief Returns whether or not the solution is definitely optimal.
+ * \return \c true if solution is definitely optimal, otherwise \c false.
  *
  *  The solution may need some further interations to determine whether it is optimal.
- *  In such cases this function returns \p false.
+ *  In such cases this function returns \c false.
  */
 bool CTSPSolver::isOptimal() const