@@ -14,39 +14,39 @@ const char *CeedBuildConfiguration = CEED_BUILD_CONFIGURATION;
14
14
/// @{
15
15
16
16
/**
17
- @brief Get output of `git describe --dirty` from build time
17
+ @brief Get output of `git describe --dirty` from build time.
18
18
19
- While @ref CeedGetVersion() uniqely identifies the source code for release
19
+ While @ref CeedGetVersion() uniquely identifies the source code for release
20
20
builds, it does not identify builds from other commits.
21
21
22
22
@param[out] git_version A static string containing the Git commit description.
23
23
24
24
If `git describe --always --dirty` fails, the string `"unknown"` will be provided.
25
25
This could occur if Git is not installed or if libCEED is not being built from a repository, for example.`
26
26
27
- @return An error code: 0 - success, otherwise - failure
28
-
29
27
@ref Developer
30
28
31
29
@sa CeedGetVersion() CeedGetBuildConfiguration()
30
+
31
+ @return An error code: 0 - success, otherwise - failure
32
32
*/
33
33
int CeedGetGitVersion (const char * * git_version ) {
34
34
* git_version = CeedGitVersion ;
35
35
return CEED_ERROR_SUCCESS ;
36
36
}
37
37
38
38
/**
39
- @brief Get build variables as a multi-line string
39
+ @brief Get build variables as a multi-line string.
40
40
41
41
Each line of the string has the format `VARNAME = value`.
42
42
43
43
@param[out] build_config A static string containing build variables
44
44
45
- @return An error code: 0 - success, otherwise - failure
46
-
47
45
@ref Developer
48
46
49
47
@sa CeedGetVersion() CeedGetGitVersion()
48
+
49
+ @return An error code: 0 - success, otherwise - failure
50
50
*/
51
51
int CeedGetBuildConfiguration (const char * * build_config ) {
52
52
* build_config = CeedBuildConfiguration ;
0 commit comments