Update design info for versions

Signed-off-by: Anna Schumaker <schumaker.anna@gmail.com>
This commit is contained in:
Anna Schumaker 2014-03-02 10:53:09 -05:00 committed by Anna Schumaker
parent 73d3c68e9f
commit e2fd4773da
1 changed files with 11 additions and 10 deletions

21
DESIGN
View File

@ -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