From 33065bc16d9d0df71702ffc29fd8dc77c766c87a Mon Sep 17 00:00:00 2001 From: Douglas Stebila Date: Sun, 24 Nov 2024 11:07:17 -0500 Subject: [PATCH] Add documentation about OQS_VERSION macros Signed-off-by: Douglas Stebila --- src/oqsconfig.h.cmake | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/oqsconfig.h.cmake b/src/oqsconfig.h.cmake index 198cc90ce..91647a1c3 100644 --- a/src/oqsconfig.h.cmake +++ b/src/oqsconfig.h.cmake @@ -1,10 +1,21 @@ // SPDX-License-Identifier: MIT +/** + * Version of liboqs as a string. Equivalent to {MAJOR}.{MINOR}.{PATCH}{PRE_RELEASE} + */ #cmakedefine OQS_VERSION_TEXT "@OQS_VERSION_TEXT@" +/** + * Version levels of liboqs as integers. + */ #define OQS_VERSION_MAJOR @OQS_VERSION_MAJOR@ #define OQS_VERSION_MINOR @OQS_VERSION_MINOR@ #define OQS_VERSION_PATCH @OQS_VERSION_PATCH@ +/** + * OQS_VERSION_PRE_RELEASE is defined if this is a pre-release version of liboqs, otherwise it is empty. + * Examples: "-dev" or "-rc1". + */ #cmakedefine OQS_VERSION_PRE_RELEASE "@OQS_VERSION_PRE_RELEASE@" + #cmakedefine OQS_COMPILE_BUILD_TARGET "@OQS_COMPILE_BUILD_TARGET@" #cmakedefine OQS_DIST_BUILD 1 #cmakedefine OQS_DIST_X86_64_BUILD 1