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


Ignore:
Timestamp:
Oct 21, 2009, 2:48:49 PM (15 years ago)
Author:
laleppa
Message:

Some documentation updates.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/tspsolver.cpp

    r65 r66  
    131131 * \param task The matrix of city-to-city travel costs.
    132132 * \param parent The parent widget for displaying messages and dialogs.
     133 * \return Pointer to the root of the solution tree.
    133134 *
    134135 * \todo TODO: Comment the algorithm.
     
    236237/*!
    237238 * \brief Returns the sorted optimal path, starting from City 1.
     239 * \return A string, containing sorted optimal path.
    238240 */
    239241QString CTSPSolver::getSortedPath() const
     
    255257/*!
    256258 * \brief Returns CTSPSolver's version ID.
    257  *
    258  *  Current version ID is <b>\$Id$</b>.
     259 * \return A string: <b>\$Id$</b>.
    259260 */
    260261QString CTSPSolver::getVersionId()
     
    265266/*!
    266267 * \brief Returns whether or not the solution is definitely optimal.
     268 * \return \c true if solution is definitely optimal, otherwise \c false.
    267269 *
    268270 *  The solution may need some further interations to determine whether it is optimal.
    269  *  In such cases this function returns \p false.
     271 *  In such cases this function returns \c false.
    270272 */
    271273bool CTSPSolver::isOptimal() const
Note: See TracChangeset for help on using the changeset viewer.