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

design: Add unit test library documentation 

This will make it easier to keep track of what functions are available.

Signed-off-by: Bryan Schumaker <bjschuma@gmail.com>
This commit is contained in:
Bryan Schumaker 2013-07-28 22:45:49 -04:00 committed by Anna Schumaker
parent 0ed8e48668
commit a190047648
2 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
design.txt
View File

@ -41,6 +41,7 @@ Files:
playlist.h
prefs.h
print.h
test.h
version.h
ocarina/lib/
audio.cpp
@ -53,6 +54,7 @@ Files:
library.cpp
playlist.cpp
prefs.cpp
test.cpp
@ -75,6 +77,19 @@ API:
Test framework: (lib/test.cpp)
Unit tests will require a basic framework for manipulating files and
directories in the filesystem. Compiling the tests/ directory will
enable the CONFIG_TEST option, which in turn compiles the test library.
API:
void rm_test_config()
Remove the $XDG_CONFG_HOME/ocarina-test/ directory.
void rm_test_data()
Remove the $XDG_DATA_HOME/ocarina-test/ directory.
Versioning: (include/version.h)
This file contains a simple function for returning a string stating
the current version.

19
design/test.txt Normal file
View File

@ -0,0 +1,19 @@
== Files ==
ocarina/include/
test.h
ocarina/lib/
test.cpp
== Depends ==
install
Test framework: (lib/test.cpp)
Unit tests will require a basic framework for manipulating files and
directories in the filesystem. Compiling the tests/ directory will
enable the CONFIG_TEST option, which in turn compiles the test library.
API:
void rm_test_config()
Remove the $XDG_CONFG_HOME/ocarina-test/ directory.
void rm_test_data()
Remove the $XDG_DATA_HOME/ocarina-test/ directory.