Even more documentation updastes.

diff --git a/Doxyfile.in b/Doxyfile.in
index dc9b0b584b4dcab9dbea8ee82e15296071b915d9..6cfe8cf368e1ce9d3144d5bdcbd367e968b6d558 100644 (file)
--- a/Doxyfile.in
+++ b/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

diff --git a/base/component.h b/base/component.h
index b5d260294f9004aab62f0878079bf5a6bbd23fee..f70fff74bf4f0e3a1278355e4529403b232ce80e 100644 (file)
--- a/base/component.h
+++ b/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) \
        {                                                               \

diff --git a/base/i2-base.h b/base/i2-base.h
index 010c44374cf951679b42cd70d65ba01a3dfbe022..3af92e0314bca49583d34ef53c95a00e3b9afaf0 100644 (file)
--- a/base/i2-base.h
+++ b/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>
  */
 
 /**

diff --git a/components/configfile/configfilecomponent.h b/components/configfile/configfilecomponent.h
index b46904f9f680b868356d5e1b93d9e03f0a756e3f..fd4d4df85b65e3c3910f6d267ca1c8d53c0b9307 100644 (file)
--- a/components/configfile/configfilecomponent.h
+++ b/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:

diff --git a/components/configfile/i2-configfile.h b/components/configfile/i2-configfile.h
index 589f8d4e4e927a9e8c76a1bc37f35e999a553365..25dbe9334592166c66050667e61d34a8c9eabdce 100644 (file)
--- a/components/configfile/i2-configfile.h
+++ b/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>
 

diff --git a/components/configrpc/configrpccomponent.h b/components/configrpc/configrpccomponent.h
index b91f646491dbd3bf69f25023e42702e5096ab68a..a7fb6d6fc465b6aeb4a9ffe688e307ee5dc5f8cc 100644 (file)
--- a/components/configrpc/configrpccomponent.h
+++ b/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:

diff --git a/components/configrpc/i2-configrpc.h b/components/configrpc/i2-configrpc.h
index 8204b729ddbcb90d2c0f9d1579cd0f2e628c4d5e..fee0b754bf9efac46e633239c3b65fbb4deefd4c 100644 (file)
--- a/components/configrpc/i2-configrpc.h
+++ b/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>

diff --git a/components/demo/democomponent.h b/components/demo/democomponent.h
index 155e04e4a743c18402c244e20b10b06ec2ca26f4..1046ccf6825947974a8e725f275490e6fd823798 100644 (file)
--- a/components/demo/democomponent.h
+++ b/components/demo/democomponent.h
@@ -23,6 +23,9 @@
 namespace icinga
 {
 
+/**
+ * @ingroup demo
+ */
 class DemoComponent : public IcingaComponent
 {
 private:

diff --git a/components/demo/i2-demo.h b/components/demo/i2-demo.h
index 7810456e402dbd9630fc984cd69240bbe55c4142..43a907db374253f53764a0acef99c5dcba1dd302 100644 (file)
--- a/components/demo/i2-demo.h
+++ b/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>

diff --git a/components/discovery/discoverycomponent.h b/components/discovery/discoverycomponent.h
index ad7f6a0eaa3106c748dc6f9cc59af6f3c72d8168..a513f4cb28da9602f880533d23bad353faa70cca 100644 (file)
--- a/components/discovery/discoverycomponent.h
+++ b/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:

diff --git a/components/discovery/discoverymessage.h b/components/discovery/discoverymessage.h
index 6390f530d767aa29a6bafa976e86ed90719900b7..cad11aa032be6e8dba2c7885a3d56936ad092a25 100644 (file)
--- a/components/discovery/discoverymessage.h
+++ b/components/discovery/discoverymessage.h
@@ -4,6 +4,9 @@
 namespace icinga
 {
 
+/**
+ * @ingroup discovery
+ */
 class DiscoveryMessage : public MessagePart
 {
 

diff --git a/components/discovery/i2-discovery.h b/components/discovery/i2-discovery.h
index febbfbfcfd0b8d85bbc8f4e69d607ec7086a33ce..834454087c1c8e5b7ac5b98da3da803f9f17e8c0 100644 (file)
--- a/components/discovery/i2-discovery.h
+++ b/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>

diff --git a/jsonrpc/netstring.h b/jsonrpc/netstring.h
index eb1da9765779aa47b474e36990f1d9ae3960bb76..bd21b2f3f184bbbfe34eac4d82a4d5015f6bf17a 100644 (file)
--- a/jsonrpc/netstring.h
+++ b/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
  */