From e2fd4773dab4e0241bb50340eeecbf0a34221812 Mon Sep 17 00:00:00 2001 From: Anna Schumaker Date: Sun, 2 Mar 2014 10:53:09 -0500 Subject: [PATCH] Update design info for versions Signed-off-by: Anna Schumaker --- DESIGN | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/DESIGN b/DESIGN index 492d78c1..457cdb68 100644 --- a/DESIGN +++ b/DESIGN @@ -69,6 +69,17 @@ Install: +Version: (include/version.h) + 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. + + + Errors: (include/error.h This file contains an enum defining error codes used throughout the codebase. Errors will be reported using "throw" and "catch". @@ -97,16 +108,6 @@ API: -Versioning: (include/version.h) - This file contains a simple function for returning a string stating - the current version. - -API: - const char *get_version(); - Returns a string describing the current version. - - - Callbacks: (lib/callback.cpp) Callbacks are used to notify a unit test or the gui that something in the backend has changed. The callbacks structure should be initialized