@@ -14,39 +14,39 @@ const char *CeedBuildConfiguration = CEED_BUILD_CONFIGURATION;
1414/// @{
1515
1616/**
17- @brief Get output of `git describe --dirty` from build time
17+ @brief Get output of `git describe --dirty` from build time.
1818
19- While @ref CeedGetVersion() uniqely identifies the source code for release
19+ While @ref CeedGetVersion() uniquely identifies the source code for release
2020 builds, it does not identify builds from other commits.
2121
2222 @param[out] git_version A static string containing the Git commit description.
2323
2424 If `git describe --always --dirty` fails, the string `"unknown"` will be provided.
2525 This could occur if Git is not installed or if libCEED is not being built from a repository, for example.`
2626
27- @return An error code: 0 - success, otherwise - failure
28-
2927 @ref Developer
3028
3129 @sa CeedGetVersion() CeedGetBuildConfiguration()
30+
31+ @return An error code: 0 - success, otherwise - failure
3232*/
3333int CeedGetGitVersion (const char * * git_version ) {
3434 * git_version = CeedGitVersion ;
3535 return CEED_ERROR_SUCCESS ;
3636}
3737
3838/**
39- @brief Get build variables as a multi-line string
39+ @brief Get build variables as a multi-line string.
4040
4141 Each line of the string has the format `VARNAME = value`.
4242
4343 @param[out] build_config A static string containing build variables
4444
45- @return An error code: 0 - success, otherwise - failure
46-
4745 @ref Developer
4846
4947 @sa CeedGetVersion() CeedGetGitVersion()
48+
49+ @return An error code: 0 - success, otherwise - failure
5050*/
5151int CeedGetBuildConfiguration (const char * * build_config ) {
5252 * build_config = CeedBuildConfiguration ;
0 commit comments