Even more documentation updastes.

Doxyfile.in

@@ -648,7 +648,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @top_srcdir@/base @top_srcdir@/icinga @top_srcdir@/jsonrpc @top_srcdir@/components @top_srcdir@/icinga-app
+INPUT                  = @top_srcdir@/base @top_srcdir@/jsonrpc @top_srcdir@/icinga @top_srcdir@/components @top_srcdir@/icinga-app
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

base/component.h

@@ -58,6 +58,12 @@ typedef Component *(*CreateComponentFunction)(void);
 #	define SYM_CREATECOMPONENT(component) component ## _LTX_CreateComponent
 #endif /* _WIN32 */
 
+/**
+ * Implements the loader function for a component.
+ *
+ * @param component The name of the component.
+ * @param klass The component class.
+ */
 #define EXPORT_COMPONENT(component, klass) \
 	extern "C" I2_EXPORT icinga::Component *SYM_CREATECOMPONENT(component)(void) \
 	{								\

base/i2-base.h

@@ -30,16 +30,18 @@
  *
  * The framework's code critically depends on the following patterns:
  *
- * -Smart pointers
+ * <list type="bullet">
+ * <item>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.
+ * management and to avoid accidental memory leaks and use-after-free bugs.</item>
  *
- * -Observer pattern
+ * <item>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.
+ * implementation.</item>
+ * </list>
  */
 
 /**

components/configfile/configfilecomponent.h

@@ -23,8 +23,16 @@
 namespace icinga
 {
 
+/**
+ * Thrown when a parser error occurs while reading a config file.
+ *
+ * @ingroup configfile
+ */
 DEFINE_EXCEPTION_CLASS(ConfigParserException);
 
+/**
+ * @ingroup configfile
+ */
 class ConfigFileComponent : public IcingaComponent
 {
 public:

components/configfile/i2-configfile.h

@@ -20,6 +20,13 @@
 #ifndef I2CONFIGFILECOMPONENT_H
 #define I2CONFIGFILECOMPONENT_H
 
+/**
+ * @defgroup configfile ConfigFile component
+ *
+ * The ConfigFile component reads configuration objects from a configuration
+ * file
+ */
+
 #include <i2-base.h>
 #include <i2-icinga.h>
 

components/configrpc/configrpccomponent.h

@@ -23,6 +23,9 @@
 namespace icinga
 {
 
+/**
+ * @ingroup configrpc
+ */
 class ConfigRpcComponent : public IcingaComponent
 {
 private:
@@ -38,7 +41,8 @@ private:
 	int RemoteObjectCommittedHandler(const NewRequestEventArgs& ea);
 	int RemoteObjectRemovedHandler(const NewRequestEventArgs& ea);
 
-	static RpcRequest MakeObjectMessage(const ConfigObject::Ptr& object, string method, bool includeProperties);
+	static RpcRequest MakeObjectMessage(const ConfigObject::Ptr& object,
+	    string method, bool includeProperties);
 
 	static bool ShouldReplicateObject(const ConfigObject::Ptr& object);
 public:

components/configrpc/i2-configrpc.h

@@ -20,6 +20,12 @@
 #ifndef I2CONFIGRPC_H
 #define I2CONFIGRPC_H
 
+/**
+ * @defgroup configrpc ConfigRpc component
+ *
+ * The ConfigRpc component replicates configuration objects to other peers.
+ */
+
 #include <i2-base.h>
 #include <i2-jsonrpc.h>
 #include <i2-icinga.h>

components/demo/democomponent.h

@@ -23,6 +23,9 @@
 namespace icinga
 {
 
+/**
+ * @ingroup demo
+ */
 class DemoComponent : public IcingaComponent
 {
 private:

components/demo/i2-demo.h

@@ -20,6 +20,12 @@
 #ifndef I2DEMO_H
 #define I2DEMO_H
 
+/**
+ * @defgroup demo Demo component
+ *
+ * The demo component periodically sends demo messages.
+ */
+
 #include <i2-base.h>
 #include <i2-jsonrpc.h>
 #include <i2-icinga.h>

components/discovery/discoverycomponent.h

@@ -23,6 +23,9 @@
 namespace icinga
 {
 
+/**
+ * @ingroup discovery
+ */
 class ComponentDiscoveryInfo : public Object
 {
 public:
@@ -38,6 +41,9 @@ public:
 	time_t LastSeen;
 };
 
+/**
+ * @ingroup discovery
+ */
 class DiscoveryComponent : public IcingaComponent
 {
 private:

components/discovery/discoverymessage.h

@@ -4,6 +4,9 @@
 namespace icinga
 {
 
+/**
+ * @ingroup discovery
+ */
 class DiscoveryMessage : public MessagePart
 {
 

components/discovery/i2-discovery.h

@@ -20,6 +20,13 @@
 #ifndef I2DISCOVERY_H
 #define I2DISCOVERY_H
 
+/**
+ * @defgroup discovery Discovery component
+ *
+ * The Discovery component takes care of connecting peers to each other
+ * and performs authorisation checks for the message subscriptions.
+ */
+
 #include <i2-base.h>
 #include <i2-jsonrpc.h>
 #include <i2-icinga.h>

jsonrpc/netstring.h

@@ -32,7 +32,8 @@ DEFINE_EXCEPTION_CLASS(InvalidNetstringException);
 
 /**
  * Helper functions for reading/writing messages in the netstring format.
- * See http://cr.yp.to/proto/netstrings.txt for details.
+ *
+ * @see http://cr.yp.to/proto/netstrings.txt
  *
  * @ingroup jsonrpc
  */