Changeset 64 in tspsg-svn for trunk


Ignore:
Timestamp:
Oct 20, 2009, 11:40:16 AM (15 years ago)
Author:
laleppa
Message:

Started documenting the source code in doxygen format.

Location:
trunk
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • trunk

    • Property svn:ignore
      •  

        old new  
        55*.sln
        66*.suo
        7 *.vcproj*
         7*.user
         8*.vcproj
        89Makefile*
        910debug
  • trunk/src/globals.h

    r58 r64  
    2525#define GLOBALS_H
    2626
     27/*!
     28 * \file globals.h
     29 * \brief This file contains TSPSG global defines.
     30 */
     31
    2732// INCLUDES
    2833#include <QtCore>
     
    3641// DEFINES
    3742// Default values
     43//! Default minimum for random numbers generation
    3844#define DEF_RAND_MIN 1
     45//! Default maximum for random numbers generation
    3946#define DEF_RAND_MAX 10
     47//! Default number of cities
    4048#define DEF_NUM_CITIES 5
     49//! Default font name
    4150#define DEF_FONT_FAMILY "Courier New"
     51//! Default font size
    4252#define DEF_FONT_SIZE 10
     53//! Default font color
    4354#define DEF_FONT_COLOR Qt::black
    4455
    45 // Maximum available number of cities
     56//! Maximum available number of cities
    4657#define MAX_NUM_CITIES 30
    47 // Maximum allowed value for random generation limits
     58//! Maximum allowed value for random generation limits
    4859#define MAX_RAND_VALUE 1000
    4960
    5061// Paths
     62/*!
     63 * \def PATH_I18N
     64 * \brief Bath to internationalization files.
     65 */
     66/*!
     67 * \def PATH_DOCS
     68 * \brief Bath to documentation files.
     69 */
    5170#if defined(Q_OS_LINUX) || defined(Q_OS_UNIX)
    5271        #define PATH_I18N "/usr/share/tspsg/i18n"
     
    5776#endif // Q_OS_LINUX
    5877
    59 // TSPSG Task file signature - letters TSPT
     78//! TSPSG Task file signature - letters \p TSPT
    6079#define TSPT quint32(0x54535054)
    61 // TSPSG Task file version
     80//! TSPSG Task file version
    6281#define TSPT_VERSION quint8(1)
    63 // TSPSG Task file metadata version
     82//! TSPSG Task file metadata version
    6483#define TSPT_META_VERSION quint8(1)
    65 // TSPSG Task file metadata size in bytes (incl. version)
     84//! TSPSG Task file metadata size in bytes (incl. version)
    6685#define TSPT_META_SIZE 2
    67 // ZKomModRd Task file signature - letters ZK
     86//! ZKomModRd Task file signature - letters \p ZK
    6887#define ZKT quint16(0x5A4B)
    69 // ZKomModRd Task file version
     88//! ZKomModRd Task file version
    7089#define ZKT_VERSION quint8(1)
    7190
    72 // This value means infinity :-)
    73 #ifndef INFINITY
    74         #define INFINITY 1.7E+308
     91// Some libraries already have INFINITY defined.
     92// We need to undefine it for INFINITY to have always the same value.
     93#ifdef INFINITY
     94        #undef INFINITY
    7595#endif
    76 // This is string, which represents infinite value in table
     96//! This value means infinity :-)
     97#define INFINITY 1.7E+308
     98//! This string represents infinite value in the table
    7799#define INFSTR "---"
    78100
     101// Sanity checks
    79102// Check that default number of cities is sane (<= MAX_NUM_CITIES)
    80103#if DEF_NUM_CITIES > MAX_NUM_CITIES
  • trunk/src/mainwindow.h

    r57 r64  
    2626
    2727#include "globals.h"
     28
    2829#include "ui_mainwindow.h"
    2930#include "settingsdialog.h"
     31
    3032#include "tspsolver.h"
    3133#include "tspmodel.h"
  • trunk/src/os.h

    r56 r64  
    2626
    2727// Some target arch detection.
    28 // NOTE: Only for GNU C, Visual Studio, Intel C/C++ and MinGW32 compilers
     28/*!
     29 * \def ARCH
     30 * \brief The target CPU architecture TSPSG was built for.
     31 * \warning NOTE: Only for GNU C, Visual Studio, Intel C/C++ and MinGW32 compilers.
     32 */
    2933#if defined(__amd64__) || defined(_M_X64)
    3034        #define ARCH " (AMD 64-bit)"
     
    4448
    4549// Target OS detection. Done by Qt, so should work with any compiler.
     50/*!
     51 * \def OS
     52 * \brief The target operating system TSPSG was built for.
     53 */
     54/*!
     55 * \def OSID
     56 * \brief The target operating system ID.
     57 *
     58 * This value is used in task file metadata.
     59 */
    4660#ifdef Q_OS_AIX
    4761        #define OS "AIX"ARCH
  • trunk/src/resource.h

    r42 r64  
    77 *
    88 *  This file is part of TSPSG.
     9 *
     10 *  TSPSG is free software: you can redistribute it and/or modify
     11 *  it under the terms of the GNU General Public License as published by
     12 *  the Free Software Foundation, either version 3 of the License, or
     13 *  (at your option) any later version.
     14 *
     15 *  TSPSG is distributed in the hope that it will be useful,
     16 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
     17 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     18 *  GNU General Public License for more details.
     19 *
     20 *  You should have received a copy of the GNU General Public License
     21 *  along with TSPSG.  If not, see <http://www.gnu.org/licenses/>.
    922 */
    1023
  • trunk/src/settingsdialog.h

    r57 r64  
    2626
    2727#include "globals.h"
     28
    2829#include "ui_settingsdialog.h"
    2930
  • trunk/src/tspsolver.cpp

    r63 r64  
    2323
    2424#include "tspsolver.h"
    25 #include "tspmodel.h"
    2625
    2726CTSPSolver::CTSPSolver()
  • trunk/src/tspsolver.h

    r63 r64  
    2626
    2727#include "globals.h"
     28
     29#include "tspmodel.h"
    2830
    2931typedef QList<QList<double> > tMatrix;
  • trunk/src/version.h

    r63 r64  
    1 /*
    2  *  TSPSG: TSP Solver and Generator
    3  *  Copyright (C) 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
     1/*! \mainpage
     2 *
     3 *  <b>TSPSG: TSP Solver and Generator</b>
     4 *  \author Copyright (C) 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
    45 *
    56 *  $Id$
     
    2526#define VERSION_H
    2627
     28/*!
     29 * \file version.h
     30 * \brief This file contains TSPSG version information defines.
     31 */
     32
     33//! TSPSG version ID
    2734#define VERSIONID "$Id$"
     35//! Major version of current TSPSG build
    2836#define BUILD_VERSION_MAJOR 0
     37//! Minor version of current TSPSG build
    2938#define BUILD_VERSION_MINOR 1
     39//! TSPSG release number
    3040#define BUILD_RELEASE 2
    31 // This will only change on releases and will be the same as revision number
     41
     42/*!
     43 * \brief Current TSPSG build number
     44 *
     45 * This will only change on releases and will be the same as revision number.
     46 *
     47 * 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 ...
     52 */
    3253#define BUILD_NUMBER 65535
    33 // Release number meanings:
    34 //   1  --  3: alpha 1 to 3
    35 //   4  --  7: beta 1 to 4
    36 //   8  -- 10: rc 1 to 3
    37 //   11 --...: release 1 to ...
     54
     55/*!
     56 * \def BUILD_STATUS
     57 * \brief TSPSG build status
     58 *
     59 * Determined based on BUILD_NUMBER.
     60 */
    3861#if BUILD_NUMBER == 65535
    3962        #define BUILD_STATUS (dev build)
     
    4669#endif // BUILD_NUMBER == 65535
    4770
    48 // "Converting" x to quoted string
     71//! Used for "conversion" of \a x to quoted string
    4972#define QUOTE_X(x) #x
    5073#define QUOTE(x) QUOTE_X(x)
    5174
     75/*!
     76 * \def BUILD_VERSION
     77 * \brief Full version of TSPSG in the form: \a major.\a minor.\a release [\a status].
     78 */
    5279#ifndef BUILD_STATUS
    5380        #define BUILD_VERSION QUOTE(BUILD_VERSION_MAJOR.BUILD_VERSION_MINOR.BUILD_RELEASE)
Note: See TracChangeset for help on using the changeset viewer.