source: trunk/yat/utility/version.h.in @ 1328

Last change on this file since 1328 was 1328, checked in by Peter, 13 years ago

added missing docs

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.2 KB
Line 
1// @configure_input@
2#ifndef _theplu_yat_utility_version_
3#define _theplu_yat_utility_version_
4
5// $Id: version.h.in 1328 2008-05-24 06:07:01Z peter $
6
7/*
8  Copyright (C) 2008 Peter Johansson
9
10  This file is part of the yat library, http://trac.thep.lu.se/yat
11
12  The yat library is free software; you can redistribute it and/or
13  modify it under the terms of the GNU General Public License as
14  published by the Free Software Foundation; either version 2 of the
15  License, or (at your option) any later version.
16
17  The yat library is distributed in the hope that it will be useful,
18  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  General Public License for more details.
21
22  You should have received a copy of the GNU General Public License
23  along with this program; if not, write to the Free Software
24  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25  02111-1307, USA.
26*/
27
28///
29/// \file utility/version.h
30///
31
32/*
33  Compile-time version constants
34
35  \see http://apr.apache.org/versioning.html
36*/
37
38/**
39   MAJOR version
40
41   No compatibility is guarenteed between MAJOR versions.
42 */
43#define YAT_MAJOR_VERSION @YAT_MAJOR_VERSION@
44
45/**
46   MINOR version
47
48   Minor API changes that do not cause binary compatibility problems.
49   Reset to 0 when upgrading YAT_MAJOR_VERSION
50 */
51#define YAT_MINOR_VERSION @YAT_MINOR_VERSION@
52
53/**
54   PATCH version
55
56   The Patch level never includes API changes, simply bug fixes.
57   Reset to 0 when upgrading YAT_MINOR_VERSION
58 */
59#define YAT_PATCH_VERSION @YAT_PATCH_VERSION@
60
61/**
62   VERSION
63
64   The version of yat in string format
65 */
66#define YAT_VERSION "@VERSION@"
67
68/**
69   DEV_BUILD
70
71   Is set to true in releases
72 */
73#define YAT_DEV_BUILD @YAT_DEV_BUILD@
74
75#include <string>
76
77namespace theplu {
78namespace yat {
79namespace utility {
80
81  /**
82     \return major version number of compiled yat library
83   */
84  unsigned int major_version(void);
85
86  /**
87     \return minor version number of compiled yat library
88   */
89  unsigned int minor_version(void);
90
91  /**
92     \return patch version number of compiled yat library
93   */
94  unsigned int patch_version(void);
95
96  /**
97     \return version number of compiled yat library
98   */
99  std::string version(void);
100
101}}} // of namespace utility, yat, and theplu
102
103#endif
Note: See TracBrowser for help on using the repository browser.