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

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

Adding \since tag for new classes and functions

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.4 KB
Line 
1// @configure_input@
2#ifndef _theplu_yat_utility_version_
3#define _theplu_yat_utility_version_
4
5// $Id: version.h.in 1339 2008-06-06 23:58:39Z 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   \since New in yat 0.5
44 */
45#define YAT_MAJOR_VERSION @YAT_MAJOR_VERSION@
46
47/**
48   MINOR version
49
50   Minor API changes that do not cause binary compatibility problems.
51   Reset to 0 when upgrading YAT_MAJOR_VERSION
52
53   \since New in yat 0.5
54 */
55#define YAT_MINOR_VERSION @YAT_MINOR_VERSION@
56
57/**
58   PATCH version
59
60   The Patch level never includes API changes, simply bug fixes.
61   Reset to 0 when upgrading YAT_MINOR_VERSION
62
63   \since New in yat 0.5
64 */
65#define YAT_PATCH_VERSION @YAT_PATCH_VERSION@
66
67/**
68   VERSION
69
70   The version of yat in string format
71
72   \since New in yat 0.5
73 */
74#define YAT_VERSION "@VERSION@"
75
76/**
77   DEV_BUILD
78
79   Is set to true in releases
80
81   \since New in yat 0.5
82 */
83#define YAT_DEV_BUILD @YAT_DEV_BUILD@
84
85#include <string>
86
87namespace theplu {
88namespace yat {
89namespace utility {
90
91  /**
92     \return major version number of compiled yat library
93
94   \since New in yat 0.5
95   */
96  unsigned int major_version(void);
97
98  /**
99     \return minor version number of compiled yat library
100
101     \since New in yat 0.5
102   */
103  unsigned int minor_version(void);
104
105  /**
106     \return patch version number of compiled yat library
107
108     \since New in yat 0.5
109   */
110  unsigned int patch_version(void);
111
112  /**
113     \return version number of compiled yat library
114
115     \since New in yat 0.5
116   */
117  std::string version(void);
118
119}}} // of namespace utility, yat, and theplu
120
121#endif
Note: See TracBrowser for help on using the repository browser.