Changeset bc1b8837b6 in tspsg for src/version.h


Ignore:
Timestamp:
Oct 20, 2009, 11:40:16 AM (15 years ago)
Author:
Oleksii Serdiuk
Branches:
0.1.3.145-beta1-symbian, 0.1.4.170-beta2-bb10, appveyor, imgbot, master, readme
Children:
caef58b531
Parents:
55c4b858e9
Message:

Started documenting the source code in doxygen format.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • src/version.h

    r55c4b858e9 rbc1b8837b6  
    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.