Perceptual Color

version.in.hpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Lukas Sommer <sommerluk@gmail.com>
2// SPDX-License-Identifier: BSD-2-Clause OR MIT
3
4#ifndef VERSION_H
5#define VERSION_H
6
7#include "importexport.h"
8
9#include <qglobal.h>
10#include <qversionnumber.h>
11
12/** @file
13 *
14 * This file provides version information for this library at compile
15 * time and at run time.
16 *
17 * @note Do not include this file itself! Instead, include <tt>version.h</tt>.
18 *
19 * @internal
20 *
21 * @note This file is configuration input: CMake processes it,
22 * puts the actual version numbers (<tt>\@…\@</tt>) and saves the result
23 * as <tt>version.h</tt>.
24 *
25 * @note This file has the extension .hpp because we want a different
26 * extension for configuration input than for headers. This allows to
27 * <em>not</em> process this file by clang-format. (clang-format does not
28 * understand the CMake configuration syntax with <tt>\@…\@</tt> and would
29 * break it.) */
30
31/** @def PERCEPTUALCOLOR_COMPILE_TIME_VERSION_MAJOR
32 *
33 * @returns The <em>major</em> version (as integer) of this library
34 * against which you are compiling. You can use this macro to use the
35 * latest features where available.
36 *
37 * To use this macro, include <tt>version.h</tt>
38 *
39 * @sa @ref versioninfo */
40#define PERCEPTUALCOLOR_COMPILE_TIME_VERSION_MAJOR (@MAJOR_VERSION@)
41
42/** @def PERCEPTUALCOLOR_COMPILE_TIME_VERSION_MINOR
43 *
44 * @returns The <em>minor</em> version (as integer) of this library
45 * against which you are compiling. You can use this macro to use the
46 * latest features where available.
47 *
48 * To use this macro, include <tt>version.h</tt>
49 *
50 * @sa @ref versioninfo */
51#define PERCEPTUALCOLOR_COMPILE_TIME_VERSION_MINOR (@MINOR_VERSION@)
52
53/** @def PERCEPTUALCOLOR_COMPILE_TIME_VERSION_PATCH
54 *
55 * @returns The <em>patch</em> version (as integer) of this library
56 * against which you are compiling. You can use this macro to use the
57 * latest features where available.
58 *
59 * To use this macro, include <tt>version.h</tt>
60 *
61 * @sa @ref versioninfo */
62#define PERCEPTUALCOLOR_COMPILE_TIME_VERSION_PATCH (@PATCH_VERSION@)
63
64/** @def PERCEPTUALCOLOR_COMPILE_TIME_VERSION
65 *
66 * @brief Against which version of this library you are <em>compiling</em>.
67 *
68 * This macro has the same semantic as <tt>QT_VERSION</tt>
69 *
70 * @returns This macro expands a numeric value of the form 0xMMNNPP
71 * (MM = major, NN = minor, PP = patch) that specifies the version number.
72 * Note that there is no pre-release identifier included. For example, if
73 * you compile your application against version 1.2.3-alpha of this library,
74 * the macro will expand to 0x010203. You can use this macro to use the
75 * latest features where available. Example:
76 *
77 * @snippet testversion.cpp Version Macro usage
78 *
79 * To use this macro, include <tt>version.h</tt>
80 *
81 * @sa @ref versioninfo */
82#define PERCEPTUALCOLOR_COMPILE_TIME_VERSION (QT_VERSION_CHECK(PERCEPTUALCOLOR_COMPILE_TIME_VERSION_MAJOR, PERCEPTUALCOLOR_COMPILE_TIME_VERSION_MINOR, PERCEPTUALCOLOR_COMPILE_TIME_VERSION_PATCH))
83
84namespace PerceptualColor
85{
87
88} // namespace PerceptualColor
89
90#endif // VERSION_H
This file provides support for C++ symbol import and export.
#define PERCEPTUALCOLOR_IMPORTEXPORT
A macro that either exports dynamic library symbols or imports dynamic library symbols or does nothin...
The namespace of this library.
QVersionNumber perceptualColorRunTimeVersion()
Against which version of this library you are running.
Definition version.cpp:33
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:48:43 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.