anna
/
ocarina
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

version: Update documentation 

I added a little more detail about how this function works.  This lets
me remove this section from the DESIGN file.

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
This commit is contained in:
Anna Schumaker 2014-11-01 11:55:06 -04:00
parent 79e2153994
commit d944ed4e95
2 changed files with 3 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
DESIGN
View File

@ -22,17 +22,6 @@ Install:
Version:
This file contains a simple function for returning a string stating
the current version. The current version will be set by the build
system and passed using the CONFIG_VERSION macro.
API:
const char *get_version();
Returns a string describing the current version.
Printing: Printing:
Sometimes text needs to be printed to the screen so users (or debuggers) Sometimes text needs to be printed to the screen so users (or debuggers)
can trace what is going on. can trace what is going on.

5
include/core/version.h
View File

@ -6,9 +6,10 @@
#define OCARINA_CORE_VERSION_H #define OCARINA_CORE_VERSION_H
/** /**
* Find the current version of Ocarina. * Scons sets the current version by passing the -DCONFIG_VERSION macro
* when Ocarina is compiled.
* *
* @return The current Ocarina version. * @return A C-style string containing the current version of Ocarina.
*/ */
static inline const char *get_version() static inline const char *get_version()
{ {