From df7de3b0b4434e1223240a9f2f5fad03a4a15f59 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Mon, 15 Oct 2012 20:31:13 +0200 Subject: [PATCH] doc: Add more details to the main page. --- doc/mainpage.dox | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 3cb4e84..76d6500 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -5,11 +5,41 @@ This is the online reference for developing with the CMocka library. It documents the CMocka C API. +@section main-motivation Motivation + +There are a variety of C unit testing frameworks available supporting different +platforms and compilers. Some development requires a lot of different compilers +and older versions which makes it difficult to use unit testing frameworks. + +The idea of CMocka is that a test application only requires the standard C +library and CMocka itself to minimize the conflicts with standard C library +headers especially on a lot of different platforms. + +Currently CMocka is tested on Linux, FreeBSD, Solaris and Windows. See the +Testing Dashboard. + + +CMocka is a fork of Google's cmockery. + @section main-features Features +CMocka tests are compiled into stand-alone executables and linked with the +CMock library, the standard C library and module being tested. Any symbols +external to the module being tested should be mocked - replaced with functions +that return values determined by the test - within the test application. Even +though significant differences may exist between the target execution +environment of a code module and the environment used to test the code the unit +testing is still valid since its goal is to test the logic of a code modules at +a functional level and not necessarily all of its interactions with the target +execution environment. + The CMocka library provides: - An easy to use framework to write unit tests. - Support for mock objects. +@section main-mock Mock objects + +TODO Explain mock objects. + */ -- 2.7.4