diff --git a/fsw/mcp750-vxworks/inc/psp_version.h b/fsw/mcp750-vxworks/inc/psp_version.h index 8c786cee..f722c454 100644 --- a/fsw/mcp750-vxworks/inc/psp_version.h +++ b/fsw/mcp750-vxworks/inc/psp_version.h @@ -18,63 +18,46 @@ ** limitations under the License. */ -/* - * File: psp_version.h - * - * Purpose: - * Provide version identifiers for the cFE Platform Support Packages (PSP). - * See cfe documentation for version and build number descriptions - * +/*! @file mcp750-vxworks/inc/psp_version.h + * @brief Purpose: + * @details Provide version identifiers for the cFE Platform Support Packages (PSP). + * See @ref cfsversions for version and build number and description */ - #ifndef _psp_version_ #define _psp_version_ -/* Development Build Macro Definitions */ +/* + * Development Build Macro Definitions + */ #define CFE_PSP_IMPL_BUILD_NUMBER 68 #define CFE_PSP_IMPL_BUILD_BASELINE "v1.4.0+dev" /* - * Macro Definitions - * ONLY APPLY for OFFICIAL releases + * Version Macro Definitions */ -#define CFE_PSP_IMPL_MAJOR_VERSION 1 -#define CFE_PSP_IMPL_MINOR_VERSION 4 -#define CFE_PSP_IMPL_REVISION 0 -#define CFE_PSP_IMPL_MISSION_REV 0 +#define CFE_PSP_IMPL_MAJOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Major version number. */ +#define CFE_PSP_IMPL_MINOR_VERSION 4 /*!< @brief ONLY APPLY for OFFICIAL releases. Minor version number. */ +#define CFE_PSP_IMPL_REVISION 0 /*!< @brief ONLY APPLY for OFFICIAL releases. Revision number. */ +#define CFE_PSP_IMPL_MISSION_REV 0 /*!< @brief ONLY USED by MISSION Implementations. Mission revision */ -#define CFE_PSP_IMPL_STR_HELPER(x) #x -#define CFE_PSP_IMPL_STR(x) CFE_PSP_IMPL_STR_HELPER(x) - -/* Baseling git tag + Number of commits since baseline */ +/* + * Tools to construct version string + */ +#define CFE_PSP_IMPL_STR_HELPER(x) #x /*!< @brief Helper function to concatenate strings from integer */ +#define CFE_PSP_IMPL_STR(x) CFE_PSP_IMPL_STR_HELPER(x) /*!< @brief Helper function to concatenate strings from integer */ + +/*! @brief Development Build Version Number. + * @details Baseline git tag + Number of commits since baseline. @n + * See @ref cfsversions for format differences between development and release versions. + */ #define CFE_PSP_IMPL_VERSION CFE_PSP_IMPL_BUILD_BASELINE CFE_PSP_IMPL_STR(CFE_PSP_IMPL_BUILD_NUMBER) +/*! @brief Development Build Version String. + * @details Reports the current development build's baseline, number, and name. Also includes a note about the latest official version. @n + * See @ref cfsversions for format differences between development and release versions. + */ #define CFE_PSP_IMPL_VERSION_STRING \ " PSP Development Build\n " CFE_PSP_IMPL_VERSION " (Codename: Bootes)" /* Codename for current development */ \ "\n Last Official Release: psp v1.4.0" /* For full support please use this version */ -/* Use the following templates for Official Releases ONLY */ - -/* Official Release format for CFE_PSP_IMPLVERSION */ - /* - #define CFE_PSP_IMPL_VERSION "v" \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MAJOR_VERSION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MINOR_VERSION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_REVISION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MISSION_REV) - */ - -/* Official Release CFE_PSP_IMPLVERSION_STRING Format */ -/* -#define CFE_PSP_IMPL_VERSION_STRING " PSP " CFE_PSP_IMPL_VERSION -*/ - - - /* Official Release CFE_PSP_IMPLVERSION_STRING Format */ - /* - #define CFE_PSP_IMPL_VERSION_STRING " PSP " CFE_PSP_IMPLVERSION - */ - -/* END TEMPLATES */ - #endif /* _psp_version_ */ diff --git a/fsw/pc-linux/inc/psp_version.h b/fsw/pc-linux/inc/psp_version.h index 1f06d6cf..a9dc8836 100644 --- a/fsw/pc-linux/inc/psp_version.h +++ b/fsw/pc-linux/inc/psp_version.h @@ -18,57 +18,46 @@ ** limitations under the License. */ -/* - * File: psp_version.h - * - * Purpose: - * Provide version identifiers for the cFE Platform Support Packages (PSP). - * See cfe documentation for version and build number descriptions - * +/*! @file pc-linux/inc/psp_version.h + * @brief Purpose: + * @details Provide version identifiers for the cFE Platform Support Packages (PSP). + * See @ref cfsversions for version and build number and description */ - #ifndef _psp_version_ #define _psp_version_ -/* Development Build Macro Definitions */ +/* + * Development Build Macro Definitions + */ #define CFE_PSP_IMPL_BUILD_NUMBER 68 #define CFE_PSP_IMPL_BUILD_BASELINE "v1.4.0+dev" /* - * Macro Definitions - * ONLY APPLY for OFFICIAL releases + * Version Macro Definitions */ -#define CFE_PSP_IMPL_MAJOR_VERSION 1 -#define CFE_PSP_IMPL_MINOR_VERSION 4 -#define CFE_PSP_IMPL_REVISION 0 -#define CFE_PSP_IMPL_MISSION_REV 0 - -#define CFE_PSP_IMPL_STR_HELPER(x) #x -#define CFE_PSP_IMPL_STR(x) CFE_PSP_IMPL_STR_HELPER(x) +#define CFE_PSP_IMPL_MAJOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Major version number. */ +#define CFE_PSP_IMPL_MINOR_VERSION 4 /*!< @brief ONLY APPLY for OFFICIAL releases. Minor version number. */ +#define CFE_PSP_IMPL_REVISION 0 /*!< @brief ONLY APPLY for OFFICIAL releases. Revision number. */ +#define CFE_PSP_IMPL_MISSION_REV 0 /*!< @brief ONLY USED by MISSION Implementations. Mission revision */ -/* Baseling git tag + Number of commits since baseline */ +/* + * Tools to construct version string + */ +#define CFE_PSP_IMPL_STR_HELPER(x) #x /*!< @brief Helper function to concatenate strings from integer */ +#define CFE_PSP_IMPL_STR(x) CFE_PSP_IMPL_STR_HELPER(x) /*!< @brief Helper function to concatenate strings from integer */ + +/*! @brief Development Build Version Number. + * @details Baseline git tag + Number of commits since baseline. @n + * See @ref cfsversions for format differences between development and release versions. + */ #define CFE_PSP_IMPL_VERSION CFE_PSP_IMPL_BUILD_BASELINE CFE_PSP_IMPL_STR(CFE_PSP_IMPL_BUILD_NUMBER) +/*! @brief Development Build Version String. + * @details Reports the current development build's baseline, number, and name. Also includes a note about the latest official version. @n + * See @ref cfsversions for format differences between development and release versions. + */ #define CFE_PSP_IMPL_VERSION_STRING \ " PSP Development Build\n " CFE_PSP_IMPL_VERSION " (Codename: Bootes)" /* Codename for current development */ \ "\n Last Official Release: psp v1.4.0" /* For full support please use this version */ -/* Use the following templates for Official Releases ONLY */ - -/* Official Release format for CFE_PSP_IMPLVERSION */ - /* - #define CFE_PSP_IMPL_VERSION "v" \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MAJOR_VERSION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MINOR_VERSION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_REVISION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MISSION_REV) - */ - - /* Official Release CFE_PSP_IMPLVERSION_STRING Format */ - /* - #define CFE_PSP_IMPL_VERSION_STRING " PSP " CFE_PSP_IMPL_VERSION - */ - -/* END TEMPLATES */ - #endif /* _psp_version_ */ diff --git a/fsw/pc-rtems/inc/psp_version.h b/fsw/pc-rtems/inc/psp_version.h index fa2b52fe..67d0da42 100644 --- a/fsw/pc-rtems/inc/psp_version.h +++ b/fsw/pc-rtems/inc/psp_version.h @@ -18,58 +18,46 @@ ** limitations under the License. */ -/* - * File: psp_version.h - * - * Purpose: - * Provide version identifiers for the cFE Platform Support Packages (PSP). - * See cfe documentation for version and build number descriptions - * +/*! @file pc-rtems/inc/psp_version.h + * @brief Purpose: + * @details Provide version identifiers for the cFE Platform Support Packages (PSP). + * See @ref cfsversions for version and build number and description */ - #ifndef _psp_version_ #define _psp_version_ -/* Development Build Macro Definitions */ +/* + * Development Build Macro Definitions + */ #define CFE_PSP_IMPL_BUILD_NUMBER 68 #define CFE_PSP_IMPL_BUILD_BASELINE "v1.4.0+dev" /* - * Macro Definitions - * ONLY APPLY for OFFICIAL releases + * Version Macro Definitions */ -#define CFE_PSP_IMPL_MAJOR_VERSION 1 -#define CFE_PSP_IMPL_MINOR_VERSION 4 -#define CFE_PSP_IMPL_REVISION 0 -#define CFE_PSP_IMPL_MISSION_REV 0 - -#define CFE_PSP_IMPL_STR_HELPER(x) #x -#define CFE_PSP_IMPL_STR(x) CFE_PSP_IMPL_STR_HELPER(x) +#define CFE_PSP_IMPL_MAJOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Major version number. */ +#define CFE_PSP_IMPL_MINOR_VERSION 4 /*!< @brief ONLY APPLY for OFFICIAL releases. Minor version number. */ +#define CFE_PSP_IMPL_REVISION 0 /*!< @brief ONLY APPLY for OFFICIAL releases. Revision number. */ +#define CFE_PSP_IMPL_MISSION_REV 0 /*!< @brief ONLY USED by MISSION Implementations. Mission revision */ -/* Baseling git tag + Number of commits since baseline */ +/* + * Tools to construct version string + */ +#define CFE_PSP_IMPL_STR_HELPER(x) #x /*!< @brief Helper function to concatenate strings from integer */ +#define CFE_PSP_IMPL_STR(x) CFE_PSP_IMPL_STR_HELPER(x) /*!< @brief Helper function to concatenate strings from integer */ + +/*! @brief Development Build Version Number. + * @details Baseline git tag + Number of commits since baseline. @n + * See @ref cfsversions for format differences between development and release versions. + */ #define CFE_PSP_IMPL_VERSION CFE_PSP_IMPL_BUILD_BASELINE CFE_PSP_IMPL_STR(CFE_PSP_IMPL_BUILD_NUMBER) +/*! @brief Development Build Version String. + * @details Reports the current development build's baseline, number, and name. Also includes a note about the latest official version. @n + * See @ref cfsversions for format differences between development and release versions. + */ #define CFE_PSP_IMPL_VERSION_STRING \ " PSP Development Build\n " CFE_PSP_IMPL_VERSION " (Codename: Bootes)" /* Codename for current development */ \ "\n Last Official Release: psp v1.4.0" /* For full support please use this version */ -/* Use the following templates for Official Releases ONLY */ - -/* Official Release format for CFE_PSP_IMPLVERSION */ - /* - #define CFE_PSP_IMPL_VERSION "v" \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MAJOR_VERSION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MINOR_VERSION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_REVISION) "." \ - CFE_PSP_IMPL_STR(CFE_PSP_IMPL_MISSION_REV) - */ - - /* Official Release CFE_PSP_IMPLVERSION_STRING Format */ - /* - #define CFE_PSP_IMPL_VERSION_STRING " PSP " CFE_PSP_IMPL_VERSION - */ - - -/* END TEMPLATES */ - #endif /* _psp_version_ */