Changeset 66 in tspsg-svn for trunk/src


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

Some documentation updates.

Location:
trunk/src
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/globals.h

    r64 r66  
    7676#endif // Q_OS_LINUX
    7777
    78 //! TSPSG Task file signature - letters \p TSPT
     78//! TSPSG Task file signature - letters \c TSPT
    7979#define TSPT quint32(0x54535054)
    8080//! TSPSG Task file version
     
    8484//! TSPSG Task file metadata size in bytes (incl. version)
    8585#define TSPT_META_SIZE 2
    86 //! ZKomModRd Task file signature - letters \p ZK
     86//! ZKomModRd Task file signature - letters \c ZK
    8787#define ZKT quint16(0x5A4B)
    8888//! ZKomModRd Task file version
    8989#define ZKT_VERSION quint8(1)
    9090
    91 // Some libraries already have INFINITY defined.
    92 // We need to undefine it for INFINITY to have always the same value.
     91/*!
     92 * \def INFINITY
     93 * \brief This value means infinity :-)
     94 *
     95 *  Some libraries already have \c INFINITY defined.
     96 *  We need to redefine it for the \c INFINITY to always have the same value.
     97 */
    9398#ifdef INFINITY
    9499        #undef INFINITY
    95100#endif
    96 //! This value means infinity :-)
    97101#define INFINITY 1.7E+308
    98102//! This string represents infinite value in the table
  • trunk/src/mainwindow.h

    r65 r66  
    2727#ifndef MAINWINDOW_H
    2828#define MAINWINDOW_H
     29
     30/*!
     31 * \file mainwindow.h
     32 * \brief Defines MainWindow class.
     33 */
    2934
    3035#include "globals.h"
  • trunk/src/os.h

    r64 r66  
    2525#define OS_H
    2626
     27/*!
     28 * \file os.h
     29 * \brief This file contains TSPSG target CPU architecture and OS detection.
     30 *
     31 *  Arch detection works only for <b>GNU C</b>, <b>Visual Studio</b>, <b>Intel C/C++</b> and <b>MinGW32</b> compilers.
     32 *
     33 *  OS detection should work for any compiler.
     34 */
     35
    2736// Some target arch detection.
    2837/*!
    2938 * \def ARCH
    3039 * \brief The target CPU architecture TSPSG was built for.
    31  * \warning NOTE: Only for GNU C, Visual Studio, Intel C/C++ and MinGW32 compilers.
     40 * \warning NOTE: Only for <b>GNU C</b>, <b>Visual Studio</b>, <b>Intel C/C++</b> and <b>MinGW32</b> compilers.
    3241 */
    3342#if defined(__amd64__) || defined(_M_X64)
     
    4756#endif // ARCH
    4857
    49 // Target OS detection. Done by Qt, so should work with any compiler.
     58// Target OS detection. Done by Qt, so should work for any compiler.
    5059/*!
    5160 * \def OS
  • trunk/src/resource.h

    r64 r66  
    2424#include "version.h"
    2525
     26/*!
     27 * \file resource.h
     28 * \brief This file contains windows resource IDs.
     29 */
     30
     31//! Version information resource ID
    2632#define VS_VERSION_INFO 1
     33//! Main application icon resource ID
    2734#define IDI_APPICON 101
  • trunk/src/settingsdialog.cpp

    r65 r66  
    226226/*!
    227227 * \brief Indicates whether or not the font color has been changed.
     228 * \return \c true if font color changed, otherwise \c false.
    228229 */
    229230bool SettingsDialog::colorChanged() const
     
    234235/*!
    235236 * \brief Indicates whether or not the font properties have been changed.
     237 * \return \c true if font properties changed, otherwise \c false.
    236238 */
    237239bool SettingsDialog::fontChanged() const
  • trunk/src/settingsdialog.h

    r65 r66  
    2727#ifndef SETTINGSDIALOG_H
    2828#define SETTINGSDIALOG_H
     29
     30/*!
     31 * \file settingsdialog.h
     32 * \brief Defines SettingsDialog class.
     33 */
    2934
    3035#include "globals.h"
  • trunk/src/tspmodel.h

    r65 r66  
    2727#ifndef TSPMODEL_H
    2828#define TSPMODEL_H
     29
     30/*!
     31 * \file tspmodel.h
     32 * \brief Defines CTSPModel class.
     33 */
    2934
    3035#include "globals.h"
  • 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
  • trunk/src/tspsolver.h

    r65 r66  
    2929#ifndef TSPSOLVER_H
    3030#define TSPSOLVER_H
     31
     32/*!
     33 * \file tspsolver.h
     34 * \brief Defines #tMatrix typedef, sStep struct and CTSPSolver class.
     35 */
    3136
    3237#include "globals.h"
  • trunk/src/version.h

    r64 r66  
    11/*! \mainpage
    22 *
     3 * \image html tspsg.png
    34 *  <b>TSPSG: TSP Solver and Generator</b>
    4  *  \author Copyright (C) 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
     5 * \author Copyright (C) 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
    56 *
    67 *  $Id$
     
    4647 *
    4748 * Build number meanings:
    48  *   - 1  --  3: alpha 1 to 3
    49  *   - 4  --  7: beta 1 to 4
    50  *   - 8  -- 10: rc 1 to 3
    51  *   - 11 --...: release 1 to ...
     49 *   - 1  --  3: <b>alpha</b> 1 to 3
     50 *   - 4  --  7: <b>beta</b> 1 to 4
     51 *   - 8  -- 10: <b>rc</b> 1 to 3
     52 *   - 11 --  x: <b>release</b> 1 to x-10
    5253 */
    5354#define BUILD_NUMBER 65535
     
    6970#endif // BUILD_NUMBER == 65535
    7071
     72//! \internal \brief A helper for QUOTE(x).
     73#define QUOTE_X(x) #x
    7174//! Used for "conversion" of \a x to quoted string
    72 #define QUOTE_X(x) #x
    7375#define QUOTE(x) QUOTE_X(x)
    7476
    7577/*!
    7678 * \def BUILD_VERSION
    77  * \brief Full version of TSPSG in the form: \a major.\a minor.\a release [\a status].
     79 * \brief Full version of TSPSG in the form: \c major.\c minor.\c release[ \c status].
    7880 */
    7981#ifndef BUILD_STATUS
Note: See TracChangeset for help on using the changeset viewer.