summaryrefslogtreecommitdiff
path: root/doc/mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'doc/mainpage.dox')
-rw-r--r--doc/mainpage.dox15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
new file mode 100644
index 0000000..3cb4e84
--- /dev/null
+++ b/doc/mainpage.dox
@@ -0,0 +1,15 @@
+/**
+
+@mainpage
+
+This is the online reference for developing with the CMocka library. It
+documents the CMocka C API.
+
+@section main-features Features
+
+The CMocka library provides:
+
+ - An easy to use framework to write unit tests.
+ - Support for mock objects.
+
+*/