Fixed more doxygen warnings.

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index 90be6a95bb3d897d55d8b9cbbaa6ccfa02cd367c..2939d3bda484abe73841ac0ba38ec4ec76d97885 100644 (file)
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -694,7 +694,7 @@ EXCLUDE_SYMLINKS       = NO
 # against the file with absolute path, so to exclude all test directories
 # for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = */lib/config/config_parser* */lib/config/config_lexer*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

diff --git a/lib/base/application.h b/lib/base/application.h
index e91af95d81249d2096335e1372440adf1dd91d3f..6bcff1bb24875af7cb415121831026abef046475 100644 (file)
--- a/lib/base/application.h
+++ b/lib/base/application.h
@@ -41,6 +41,12 @@ public:
 
        int Run(int argc, char **argv);
 
+       /**
+        * Starts the application.
+        *
+        * @param args Arguments for the application.
+        * @returns The exit code of the application.
+        */
        virtual int Main(const vector<String>& args) = 0;
 
        static void Shutdown(void);

diff --git a/lib/base/asynctask.h b/lib/base/asynctask.h
index b953b854fb8260dafd61fbeb259e90a7b12396bc..66d438be30eb6d42714d4a1fa89be4edab5d0c03 100644 (file)
--- a/lib/base/asynctask.h
+++ b/lib/base/asynctask.h
@@ -118,6 +118,11 @@ public:
        }
 
 protected:
+       /**
+        * Begins executing the task. The Run method must ensure
+        * that one of the Finish*() functions is executed on the task
+        * object (possibly after the Run method has returned).
+        */
        virtual void Run(void) = 0;
 
 private:

diff --git a/lib/base/dynamicobject.cpp b/lib/base/dynamicobject.cpp
index 60471c2888a60d453ced62621dd6d0c7a283cfaa..768ead8fde6756b6aeff79ef6922fcb6ab2bf083 100644 (file)
--- a/lib/base/dynamicobject.cpp
+++ b/lib/base/dynamicobject.cpp
@@ -214,16 +214,6 @@ void DynamicObject::ClearAttributesByType(DynamicAttributeType type)
        }
 }
 
-DynamicObject::AttributeConstIterator DynamicObject::AttributeBegin(void) const
-{
-       return m_Attributes.begin();
-}
-
-DynamicObject::AttributeConstIterator DynamicObject::AttributeEnd(void) const
-{
-       return m_Attributes.end();
-}
-
 String DynamicObject::GetType(void) const
 {
        return Get("__type");

diff --git a/lib/base/dynamicobject.h b/lib/base/dynamicobject.h
index 42619e29ba82bb1913d61036244febdab9b767e5..e2e46526312e40c4096c46cd64a9dcbdeb72eea4 100644 (file)
--- a/lib/base/dynamicobject.h
+++ b/lib/base/dynamicobject.h
@@ -51,9 +51,9 @@ enum DynamicAttributeType
  */
 struct DynamicAttribute
 {
-       Value Data;
-       DynamicAttributeType Type;
-       double Tx;
+       Value Data; /**< The current value of the attribute. */
+       DynamicAttributeType Type; /**< The type of the attribute. */
+       double Tx; /**< The timestamp of the last value change. */
 };
 
 /**
@@ -93,9 +93,6 @@ public:
 
        void ClearAttributesByType(DynamicAttributeType type);
 
-       AttributeConstIterator AttributeBegin(void) const;
-       AttributeConstIterator AttributeEnd(void) const;
-
        static boost::signal<void (const DynamicObject::Ptr&)> OnRegistered;
        static boost::signal<void (const DynamicObject::Ptr&)> OnUnregistered;
        static boost::signal<void (const set<DynamicObject::Ptr>&)> OnTransactionClosing;

diff --git a/lib/base/logger.cpp b/lib/base/logger.cpp
index 9d9f003c7c74453f4c7a8294db8b9d6f7a84dd28..3ed277df1a8ae311a3afc1d111480ee446671380 100644 (file)
--- a/lib/base/logger.cpp
+++ b/lib/base/logger.cpp
@@ -164,3 +164,14 @@ LogSeverity Logger::StringToSeverity(const String& severity)
        else
                throw_exception(invalid_argument("Invalid severity: " + severity));
 }
+
+/**
+ * Retrieves the configuration object that belongs to this logger.
+ *
+ * @returns The configuration object.
+ */
+DynamicObject::Ptr ILogger::GetConfig(void) const
+{
+       return m_Config->GetSelf();
+}
+

diff --git a/lib/base/logger.h b/lib/base/logger.h
index 1b642fb5999a5cd4d01eec82408a228d225eb563..58eeae57fc1042c01987af123a7e456ab9f4d39e 100644 (file)
--- a/lib/base/logger.h
+++ b/lib/base/logger.h
@@ -42,10 +42,10 @@ enum LogSeverity
  * @ingroup base
  */
 struct LogEntry {
-       double Timestamp;
-       LogSeverity Severity;
-       String Facility;
-       String Message;
+       double Timestamp; /**< The timestamp when this log entry was created. */
+       LogSeverity Severity; /**< The severity of this log entry. */
+       String Facility; /**< The facility this log entry belongs to. */
+       String Message; /**< The log entry's message. */
 };
 
 /**
@@ -59,6 +59,12 @@ public:
        typedef shared_ptr<ILogger> Ptr;
        typedef weak_ptr<ILogger> WeakPtr;
 
+       /**
+        * Processes the log entry and writes it to the log that is
+        * represented by this ILogger object.
+        *
+        * @param entry The log entry that is to be processed.
+        */
        virtual void ProcessLogEntry(const LogEntry& entry) = 0;
 
 protected:

diff --git a/lib/config/configcompiler.h b/lib/config/configcompiler.h
index 782597a33c68021b291b60a7f28091bdb9ba3657..ef4c572a947ad049a5630283e9212759b42ec55b 100644 (file)
--- a/lib/config/configcompiler.h
+++ b/lib/config/configcompiler.h
@@ -23,6 +23,12 @@
 namespace icinga
 {
 
+/**
+ * The configuration compiler can be used to compile a configuration file
+ * into a number of configuration objects.
+ *
+ * @ingroup config
+ */
 class I2_CONFIG_API ConfigCompiler
 {
 public:

diff --git a/lib/config/configitem.h b/lib/config/configitem.h
index 699d379ee5c7c270748fef24c1bd8ddd3b24ae55..0c1307dca9009167aec0c9deeda2ed0feea55c42 100644 (file)
--- a/lib/config/configitem.h
+++ b/lib/config/configitem.h
@@ -23,6 +23,12 @@
 namespace icinga
 {
 
+/**
+ * A configuration item. Can be used to create a configuration object at
+ * runtime.
+ *
+ * @ingroup config
+ */
 class I2_CONFIG_API ConfigItem : public Object {
 public:
        typedef shared_ptr<ConfigItem> Ptr;

diff --git a/lib/config/configitembuilder.h b/lib/config/configitembuilder.h
index b1e46045ca8d9c0a115f39703e20edcd4a479cbb..9bd887b60fd097615df8d3654d536049a30ffe3e 100644 (file)
--- a/lib/config/configitembuilder.h
+++ b/lib/config/configitembuilder.h
@@ -23,6 +23,12 @@
 namespace icinga
 {
 
+/**
+ * Config item builder. Used to dynamically build configuration objects
+ * at runtime.
+ *
+ * @ingroup config
+ */
 class I2_CONFIG_API ConfigItemBuilder : public Object
 {
 public:

diff --git a/lib/config/debuginfo.h b/lib/config/debuginfo.h
index c6999a9bb2ac32d87e4f58258505f81862047b45..984c378aac661a88c7a25b5e0ea939af67cc89f2 100644 (file)
--- a/lib/config/debuginfo.h
+++ b/lib/config/debuginfo.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * Debug information for a configuration element.
+ *
+ * @ingroup config
+ */
 struct DebugInfo
 {
        String Path;

diff --git a/lib/config/expression.h b/lib/config/expression.h
index b239b7b532b6c3851dad772c2a1a45466bd5ba40..533b0979f35bf76997f2a2b5286eb329adb8a60d 100644 (file)
--- a/lib/config/expression.h
+++ b/lib/config/expression.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * The operator in a configuration expression.
+ *
+ * @ingroup config
+ */
 enum ExpressionOperator
 {
        OperatorExecute,
@@ -33,6 +38,11 @@ enum ExpressionOperator
        OperatorDivide
 };
 
+/**
+ * A configuration expression.
+ *
+ * @ingroup config
+ */
 struct I2_CONFIG_API Expression
 {
 public:

diff --git a/lib/config/expressionlist.h b/lib/config/expressionlist.h
index 9869b60bf9fc87e53315a820938bacfe72f93608..a4f29fcf02f6f6f4302835123a169cd5fc55d596 100644 (file)
--- a/lib/config/expressionlist.h
+++ b/lib/config/expressionlist.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * A list of configuration expressions.
+ *
+ * @ingroup config
+ */
 class I2_CONFIG_API ExpressionList : public Object
 {
 public:

diff --git a/lib/remoting/endpoint.cpp b/lib/remoting/endpoint.cpp
index 0de95603d5a8e0b66cc4a33fc2f68c5a52aa0bea..c2dcb775d4d09157e6608cfa56f8aa672bd38940 100644 (file)
--- a/lib/remoting/endpoint.cpp
+++ b/lib/remoting/endpoint.cpp
@@ -28,6 +28,11 @@ boost::signal<void (const Endpoint::Ptr&)> Endpoint::OnDisconnected;
 boost::signal<void (const Endpoint::Ptr&, const String& topic)> Endpoint::OnSubscriptionRegistered;
 boost::signal<void (const Endpoint::Ptr&, const String& topic)> Endpoint::OnSubscriptionUnregistered;
 
+/**
+ * Constructor for the Endpoint class.
+ *
+ * @param properties A serialized dictionary containing attributes.
+ */
 Endpoint::Endpoint(const Dictionary::Ptr& serializedUpdate)
        : DynamicObject(serializedUpdate)
 {
@@ -38,11 +43,23 @@ Endpoint::Endpoint(const Dictionary::Ptr& serializedUpdate)
        RegisterAttribute("client", Attribute_Transient);
 }
 
+/**
+ * Checks whether an endpoint with the specified name exists.
+ *
+ * @param name The name of the endpoint.
+ * @returns true if the endpoint exists, false otherwise.
+ */
 bool Endpoint::Exists(const String& name)
 {
        return (DynamicObject::GetObject("Endpoint", name));
 }
 
+/**
+ * Retrieves an endpoint by name.
+ *
+ * @param name The name of the endpoint.
+ * @returns The endpoint.
+ */
 Endpoint::Ptr Endpoint::GetByName(const String& name)
 {
         DynamicObject::Ptr configObject = DynamicObject::GetObject("Endpoint", name);
@@ -53,6 +70,13 @@ Endpoint::Ptr Endpoint::GetByName(const String& name)
         return dynamic_pointer_cast<Endpoint>(configObject);
 }
 
+/**
+ * Helper function for creating new endpoint objects.
+ *
+ * @param name The name of the new endpoint.
+ * @param local Whether the new endpoint should be local.
+ * @returns The new endpoint.
+ */
 Endpoint::Ptr Endpoint::MakeEndpoint(const String& name, bool local)
 {
        ConfigItemBuilder::Ptr endpointConfig = boost::make_shared<ConfigItemBuilder>();
@@ -334,11 +358,21 @@ void Endpoint::ClientClosedHandler(void)
        OnDisconnected(GetSelf());
 }
 
+/**
+ * Gets the node address for this endpoint.
+ *
+ * @returns The node address (hostname).
+ */
 String Endpoint::GetNode(void) const
 {
        return Get("node");
 }
 
+/**
+ * Gets the service name for this endpoint.
+ *
+ * @returns The service name (port).
+ */
 String Endpoint::GetService(void) const
 {
        return Get("service");