diff --git a/DESIGN b/DESIGN index 136df7d8..4eff3a21 100644 --- a/DESIGN +++ b/DESIGN @@ -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: Sometimes text needs to be printed to the screen so users (or debuggers) can trace what is going on. diff --git a/include/core/version.h b/include/core/version.h index f5aaf4d6..4a14007f 100644 --- a/include/core/version.h +++ b/include/core/version.h @@ -6,9 +6,10 @@ #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() {