diff options
author | Mauro Sardara <msardara+fdio@cisco.com> | 2018-12-18 11:05:49 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2018-12-18 11:05:49 +0000 |
commit | cada1143501a48effc483e3873596c22849926b5 (patch) | |
tree | 93a1da95d69b69328a1e7d3621447797f65137c9 /longbow/src/LongBow/Groups.dox | |
parent | 726949d76a7207694d5a1eee84ef134a8e539115 (diff) | |
parent | a45edf23c2463ac9a4723a24792a6c5c89b1e021 (diff) |
Merge "Adding gitreview config file for this branch sub project"
Diffstat (limited to 'longbow/src/LongBow/Groups.dox')
-rw-r--r-- | longbow/src/LongBow/Groups.dox | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/longbow/src/LongBow/Groups.dox b/longbow/src/LongBow/Groups.dox new file mode 100644 index 00000000..758f7abc --- /dev/null +++ b/longbow/src/LongBow/Groups.dox @@ -0,0 +1,47 @@ +/** +\mainpage LongBow + +Software testing, validation, and measurable quality metics are an important +element in modern software development. LongBow is a software framework and +facility for writing software using invariants, runtime validation, +unit testing, and code analysis for the C programming language. + +LongBow is software to help you write better C programs. It provides: + +* A run-time assertion facility to establish strict rules on the state of your program. +* A testing facility based on the xUnit testing model. +* Compile-time assistance for writing code meant to be compiled by compilers with different features. + +LongBow can help you find and manage problems early, establish and maintain + confidence in the correctness of your code, make collaboration easier, +facilitate future change, and improve overall design. + +LongBow allows you to take control and establish invariant pre- and +post-conditions that detect inconsistencies and unexpected results in your +programs in order to find bugs and design deficiencies in the code during +development rather than waiting for your users and customers to find your bugs for you. + + +@defgroup runtime Runtime +@brief LongBow functions and macros for runtime, consisting primarily of assertions and traps. + +@defgroup testing Testing +@brief LongBow functions and macros for writing tests. + +LongBow testing Macros and ancillary functions to implement an xUnit style of writing and running tests. +Test writers create a `LONGBOW_TEST_RUNNER` function which, in turn, +invokes one or more `LONGBOW_TEST_FIXTURE` functions, +each of which invoke a specific `LONGBOW_TEST_CASE`. + +@defgroup internals Internals +@brief LongBow functions and macros used internally. + +@defgroup reporting Reporting +@brief LongBow functions and definitions for writing report libraries. + +@defgroup performance Performance testing +@brief LongBow functions and definitions for writing performance tests. + +@example testAssertion.c +*/ + |