From 1584e03fa3ca8a3e135e457e1e28234cd7bc3fd0 Mon Sep 17 00:00:00 2001
From: Gunnar Beutner <gunnar.beutner@netways.de>
Date: Sat, 19 May 2012 10:48:00 +0200
Subject: [PATCH] Documentation update.

---
 base/i2-base.h       | 23 +++++++++++++++++++++--
 icinga/i2-icinga.h   |  3 +++
 jsonrpc/i2-jsonrpc.h |  3 +++
 3 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/base/i2-base.h b/base/i2-base.h
index dea64ff24..010c44374 100644
--- a/base/i2-base.h
+++ b/base/i2-base.h
@@ -21,13 +21,32 @@
 #define I2BASE_H
 
 /**
- * @mainpage Foo
+ * @mainpage Icinga Documentation
+ *
+ * Icinga implements a framework for run-time-loadable components which can
+ * pass messages between them. These components can either be hosted in the
+ * same process or in several host processes (either on the same machine or
+ * on different machines).
+ *
+ * The framework's code critically depends on the following patterns:
+ *
+ * -Smart pointers
+ *
+ * The shared_ptr and weak_ptr template classes are used to simplify memory
+ * management and to avoid accidental memory leaks and use-after-free bugs.
+ *
+ * -Observer pattern
+ *
+ * Framework classes expose events which other objects can subscribe to. This
+ * is used to decouple clients of a class from the class' internal
+ * implementation.
  */
 
 /**
  * @defgroup base Base class library
  *
- * Hello World.
+ * The base class library implements commonly-used functionality like
+ * event handling for sockets and timers.
  */
 
 #ifdef _MSC_VER
diff --git a/icinga/i2-icinga.h b/icinga/i2-icinga.h
index 67a785953..cc0f50cea 100644
--- a/icinga/i2-icinga.h
+++ b/icinga/i2-icinga.h
@@ -22,6 +22,9 @@
 
 /**
  * @defgroup icinga Icinga application
+ *
+ * The Icinga application is in charge of boot-strapping the Icinga
+ * environment and loading additional components.
  */
 
 #include <i2-base.h>
diff --git a/jsonrpc/i2-jsonrpc.h b/jsonrpc/i2-jsonrpc.h
index 240247a84..1fdd52d83 100644
--- a/jsonrpc/i2-jsonrpc.h
+++ b/jsonrpc/i2-jsonrpc.h
@@ -22,6 +22,9 @@
 
 /**
  * @defgroup jsonrpc JSON-RPC
+ *
+ * The JSON-RPC library implements server and client classes for the JSON-RPC
+ * protocol.
  */
 
 #include <map>