From ed230f69453816c5872067d0cc24c1627db43255 Mon Sep 17 00:00:00 2001 From: Hugues Delorme Date: Thu, 6 Apr 2017 15:03:32 +0200 Subject: [PATCH] core: make version.h appear in generated doc --- doc/Doxyfile.cmake | 6 ++++-- src/gmio_core/version.h.cmake | 18 ++++++++++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/doc/Doxyfile.cmake b/doc/Doxyfile.cmake index 654f364..5151f8c 100644 --- a/doc/Doxyfile.cmake +++ b/doc/Doxyfile.cmake @@ -128,7 +128,8 @@ FULL_PATH_NAMES = YES # If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@/../src +STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@/../src \ + @CMAKE_CURRENT_BINARY_DIR@/../src # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells @@ -642,7 +643,8 @@ WARN_LOGFILE = # with spaces. INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../doc/mainpage.dox \ - @CMAKE_CURRENT_SOURCE_DIR@/../src + @CMAKE_CURRENT_SOURCE_DIR@/../src \ + @CMAKE_CURRENT_BINARY_DIR@/../src/gmio_core/version.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/src/gmio_core/version.h.cmake b/src/gmio_core/version.h.cmake index 3188bb3..8a33687 100644 --- a/src/gmio_core/version.h.cmake +++ b/src/gmio_core/version.h.cmake @@ -29,11 +29,29 @@ /* Generated by CMake */ +/*! \file version.h + * Declaration of macros specifying gmio's version + * + * \addtogroup gmio_core + * @{ + */ + #pragma once +/*! Expands to gmio's major version number */ #define GMIO_VERSION_MAJOR @GMIO_VERSION_MAJOR@ + +/*! Expands to gmio's minor version number */ #define GMIO_VERSION_MINOR @GMIO_VERSION_MINOR@ + +/*! Expands to gmio's patch version number */ #define GMIO_VERSION_PATCH @GMIO_VERSION_PATCH@ + +/*! Expands to a string that specifies gmio's version number */ #define GMIO_VERSION_STR "@GMIO_VERSION@" + +/*! Expands to an hexadecimal value of the form \c 0xMMNNPP (MM=major, NN=minor, + * PP=patch) that specifies gmio's version number */ #define GMIO_VERSION 0x0@GMIO_VERSION_MAJOR@0@GMIO_VERSION_MINOR@0@GMIO_VERSION_PATCH@ +/*! @} */