Updated doxygen documentation.

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index 914126ca6b9ffd99c917e88cf41de7fc1ac47a71..90be6a95bb3d897d55d8b9cbbaa6ccfa02cd367c 100644 (file)
--- a/docs/Doxyfile.in
+++ b/docs/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@/jsonrpc @top_srcdir@/icinga @top_srcdir@/components @top_srcdir@/icinga-app
+INPUT                  = lib/base lib/config lib/icinga lib/remoting components 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/lib/base/component.h b/lib/base/component.h
index ce6f6d3b0e44cf85030985b0dceb5c51b726c670..d87335f4bc8aeb4ddae0ed65be840637dc3178ff 100644 (file)
--- a/lib/base/component.h
+++ b/lib/base/component.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * Interface for application extensions.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API IComponent : public Object
 {
 public:

diff --git a/lib/base/dictionary.cpp b/lib/base/dictionary.cpp
index e9442b1831b04a35d8f84f09fa89afb649990cef..7bf487028481b149e9d2b5900cb70503b730cfca 100644 (file)
--- a/lib/base/dictionary.cpp
+++ b/lib/base/dictionary.cpp
@@ -217,9 +217,8 @@ Dictionary::Ptr Dictionary::FromJson(cJSON *json)
 }
 
 /**
- * Converts a dictionary to a JSON object.
+ * Converts this dictionary to a JSON object.
  *
- * @param dictionary The dictionary.
  * @returns A JSON object that is equivalent to the dictionary. Values that
  *         cannot be represented in JSON are omitted.
  */

diff --git a/lib/base/dynamicobject.h b/lib/base/dynamicobject.h
index 6ff8b77ac7d8b58ba22368dbbe56fb79e9576768..42619e29ba82bb1913d61036244febdab9b767e5 100644 (file)
--- a/lib/base/dynamicobject.h
+++ b/lib/base/dynamicobject.h
@@ -23,6 +23,9 @@
 namespace icinga
 {
 
+/**
+ * The type of an attribute for a DynamicObject.
+ */
 enum DynamicAttributeType
 {
        Attribute_Transient = 1,
@@ -43,6 +46,9 @@ enum DynamicAttributeType
        Attribute_All = Attribute_Transient | Attribute_Local | Attribute_Replicated | Attribute_Config
 };
 
+/**
+ * An attribute for a DynamicObject.
+ */
 struct DynamicAttribute
 {
        Value Data;
@@ -51,7 +57,8 @@ struct DynamicAttribute
 };
 
 /**
- * A dynamic object that can be instantiated from the configuration file.
+ * A dynamic object that can be instantiated from the configuration file
+ * and that supports attribute replication to remote application instances.
  *
  * @ingroup base
  */
@@ -147,6 +154,11 @@ private:
        void InternalApplyUpdate(const Dictionary::Ptr& serializedUpdate, int allowedTypes, bool suppressEvents);
 };
 
+/**
+ * Helper class for registering DynamicObject implementation classes.
+ *
+ * @ingroup base
+ */
 class RegisterClassHelper
 {
 public:

diff --git a/lib/base/event.h b/lib/base/event.h
index 06ebe1f32410b52aab5b470790fc7db4caff602c..8a64b2ed6f9e6e3e499cd1bfefbaf7cebc425b10 100644 (file)
--- a/lib/base/event.h
+++ b/lib/base/event.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * A thread-safe event that can be posted to the main thread's event queue.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API Event
 {
 public:

diff --git a/lib/base/fifo.cpp b/lib/base/fifo.cpp
index 755bf1768c4ffbaa3ac1830a2672209b01a1b2cd..5f9e59bfde233d13aec3fd19d53d6705177e558c 100644 (file)
--- a/lib/base/fifo.cpp
+++ b/lib/base/fifo.cpp
@@ -130,21 +130,6 @@ void FIFO::Read(void *buffer, size_t count)
        Optimize();
 }
 
-/**
- * Returns a pointer to the start of the write buffer.
- *
- * @param count Minimum size of the buffer; on return this parameter
- *              contains the actual size of the available buffer which can
- *              be larger than the requested size.
- */
-/*void *FIFO::GetWriteBuffer(size_t *count)
-{
-       ResizeBuffer(m_Offset + m_DataSize + *count);
-       *count = m_AllocSize - m_Offset - m_DataSize;
-
-       return m_Buffer + m_Offset + m_DataSize;
-}*/
-
 /**
  * Implements IOQueue::Write.
  */

diff --git a/lib/base/ioqueue.h b/lib/base/ioqueue.h
index 3ec17185cff17361370b6cdc954d977f72509f0b..842e9461f0e6d1c2139c0517493e90ee1b506143 100644 (file)
--- a/lib/base/ioqueue.h
+++ b/lib/base/ioqueue.h
@@ -25,6 +25,8 @@ namespace icinga
 
 /**
  * An I/O queue.
+ *
+ * @ingroup base
  */
 class IOQueue
 {
@@ -41,8 +43,8 @@ public:
         * to read more data than is available in the queue is a programming error.
         * Use GetBytesAvailable() to check how much data is available.
         *
-        * @buffer The buffer where data should be stored. May be NULL if you're
-        *               not actually interested in the data.
+        * @param buffer The buffer where data should be stored. May be NULL if
+        *               you're not actually interested in the data.
         * @param count The number of bytes to read from the queue.
         */
        virtual void Peek(void *buffer, size_t count) = 0;

diff --git a/lib/base/logger.cpp b/lib/base/logger.cpp
index ff3c5bd4a415ca262dfd626be72b9c55f5306e23..9d9f003c7c74453f4c7a8294db8b9d6f7a84dd28 100644 (file)
--- a/lib/base/logger.cpp
+++ b/lib/base/logger.cpp
@@ -24,10 +24,9 @@ using namespace icinga;
 REGISTER_CLASS(Logger);
 
 /**
- * Constructor for the logger class.
+ * Constructor for the Logger class.
  *
- * @param minSeverity The minimum severity of log messages that should be sent
- *                    to this logger.
+ * @param properties A serialized dictionary containing attributes.
  */
 Logger::Logger(const Dictionary::Ptr& properties)
        : DynamicObject(properties)

diff --git a/lib/base/logger.h b/lib/base/logger.h
index 49a61863d4e13d7b5bcff169976393da5f807ab0..1b642fb5999a5cd4d01eec82408a228d225eb563 100644 (file)
--- a/lib/base/logger.h
+++ b/lib/base/logger.h
@@ -50,6 +50,8 @@ struct LogEntry {
 
 /**
  * Base class for all loggers.
+ *
+ * @ingroup base
  */
 class I2_BASE_API ILogger : public Object
 {
@@ -68,6 +70,11 @@ private:
        friend class Logger;
 };
 
+/**
+ * A log provider. Can be instantiated from the config.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API Logger : public DynamicObject
 {
 public:

diff --git a/lib/base/netstring.cpp b/lib/base/netstring.cpp
index ff23cd275a143e386e058ca0d5b97da256e809d4..3519580cae19954779b5ab5ed55411c55cb1cc3d 100644 (file)
--- a/lib/base/netstring.cpp
+++ b/lib/base/netstring.cpp
@@ -24,9 +24,9 @@ using namespace icinga;
 /**
  * Reads data from an IOQueue in netString format.
  *
- * @param fifo The IOQueue to read from.
- * @param[out] str The String that has been read from the FIFO.
- * @returns true if a complete String was read from the FIFO, false otherwise.
+ * @param queue The IOQueue to read from.
+ * @param[out] str The String that has been read from the IOQueue.
+ * @returns true if a complete String was read from the IOQueue, false otherwise.
  * @exception invalid_argument The input stream is invalid.
  * @see https://github.com/PeterScott/netString-c/blob/master/netString.c
  */
@@ -104,16 +104,16 @@ bool NetString::ReadStringFromIOQueue(IOQueue *queue, String *str)
 
        free(buffer);
 
-       /* remove the data from the fifo */
+       /* remove the data from the IOQueue */
        queue->Read(NULL, buffer_length);
 
        return true;
 }
 
 /**
- * Writes data into a FIFO using the netString format.
+ * Writes data into an IOQueue using the netString format.
  *
- * @param fifo The FIFO.
+ * @param queue The IOQueue.
  * @param str The String that is to be written.
  */
 void NetString::WriteStringToIOQueue(IOQueue *queue, const String& str)

diff --git a/lib/base/process.h b/lib/base/process.h
index 36fb486a296e02e68b821ac1c3f0e7fbe1cee860..10fa8d33d1ded50d30c62c5b8c606fe4dc214096 100644 (file)
--- a/lib/base/process.h
+++ b/lib/base/process.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * The result of a Process task.
+ *
+ * @ingroup base
+ */
 struct ProcessResult
 {
        double ExecutionStart;
@@ -31,6 +36,12 @@ struct ProcessResult
        String Output;
 };
 
+/**
+ * A process task. Executes an external application and returns the exit
+ * code and console output.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API Process : public AsyncTask<Process, ProcessResult>
 {
 public:

diff --git a/lib/base/qstring.cpp b/lib/base/qstring.cpp
index a979002a7892b51d83989943389525f48c0cb532..03f0a3cf5c7299b7897f921a16c7bedb96b414a1 100644 (file)
--- a/lib/base/qstring.cpp
+++ b/lib/base/qstring.cpp
@@ -1,3 +1,22 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
 #include "i2-base.h"
 
 using namespace icinga;

diff --git a/lib/base/qstring.h b/lib/base/qstring.h
index c76fcf6a273e4551592af8ed334e30cba0bb450f..b5fe1c87ccc0875104931e13b47527d098c5e9b7 100644 (file)
--- a/lib/base/qstring.h
+++ b/lib/base/qstring.h
@@ -1,3 +1,22 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
 #ifndef STRING_H
 #define STRING_H
 
@@ -6,7 +25,7 @@ namespace icinga {
 /**
  * String class.
  *
- * Rationale: The std::string class has an ambiguous assignment
+ * Rationale for having this: The std::string class has an ambiguous assignment
  * operator when used in conjunction with the Value class.
  */
 class I2_BASE_API String

diff --git a/lib/base/ringbuffer.h b/lib/base/ringbuffer.h
index fc85a8cbe70e44b28b17374cd6a04067fc4b1962..217788246d8622676b0fa7648f71122056069a6e 100644 (file)
--- a/lib/base/ringbuffer.h
+++ b/lib/base/ringbuffer.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * A ring buffer that holds a pre-defined number of integers.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API RingBuffer
 {
 public:

diff --git a/lib/base/scriptfunction.h b/lib/base/scriptfunction.h
index 94bbc7138a1450152126b7a5faa202659337fa45..86a4594154d5e81df8f8b0135f1389a58e827659 100644 (file)
--- a/lib/base/scriptfunction.h
+++ b/lib/base/scriptfunction.h
@@ -25,6 +25,11 @@ namespace icinga
 
 class ScriptTask;
 
+/**
+ * A script function that can be used to execute a script task.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API ScriptFunction : public Object
 {
 public:

diff --git a/lib/base/scripttask.h b/lib/base/scripttask.h
index 7f55910d33856d7930fe40f1586d4b73149c4e66..71d5912cfbe3b242a74aa1d9ba440511295d18db 100644 (file)
--- a/lib/base/scripttask.h
+++ b/lib/base/scripttask.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * A script task.
+ *
+ * @ingroup base
+ */
 class I2_BASE_API ScriptTask : public AsyncTask<ScriptTask, Value>
 {
 public:

diff --git a/lib/base/streamlogger.cpp b/lib/base/streamlogger.cpp
index c35da60da4771120aa8c8a5b5fdfdfca0e575c4c..758484a142226604f07ba5c31cc658a5f1fe3e6c 100644 (file)
--- a/lib/base/streamlogger.cpp
+++ b/lib/base/streamlogger.cpp
@@ -13,7 +13,6 @@ StreamLogger::StreamLogger(void)
  * Constructor for the StreamLogger class.
  *
  * @param stream The stream.
- * @param minSeverity Minimum severity for log messages.
  */
 StreamLogger::StreamLogger(ostream *stream)
        : ILogger(), m_Stream(stream), m_OwnsStream(false)

diff --git a/lib/base/streamlogger.h b/lib/base/streamlogger.h
index c06a4777c3122bd2f940b70358ebe4030d3f00f5..541e5869d633c41013f64b471bd79e17f276155b 100644 (file)
--- a/lib/base/streamlogger.h
+++ b/lib/base/streamlogger.h
@@ -5,7 +5,9 @@ namespace icinga
 {
 
 /**
- * A logger that logs to stdout.
+ * A logger that logs to an iostream.
+ *
+ * @ingroup base
  */
 class I2_BASE_API StreamLogger : public ILogger
 {

diff --git a/lib/base/sysloglogger.cpp b/lib/base/sysloglogger.cpp
index 8b66997b949526793c3e9cfb789f837f1902bd55..838d461f1c8c8e4a572e51e4d2a12d2ef0448e67 100644 (file)
--- a/lib/base/sysloglogger.cpp
+++ b/lib/base/sysloglogger.cpp
@@ -1,3 +1,22 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
 #include "i2-base.h"
 
 #ifndef _WIN32

diff --git a/lib/base/sysloglogger.h b/lib/base/sysloglogger.h
index 19fa6d02ecea4751730cc1b86f1fe95133a15bd3..291658d70952868538d69f690b15e99c533e10c4 100644 (file)
--- a/lib/base/sysloglogger.h
+++ b/lib/base/sysloglogger.h
@@ -1,3 +1,22 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
+ *                                                                            *
+ * This program is free software; you can redistribute it and/or              *
+ * modify it under the terms of the GNU General Public License                *
+ * as published by the Free Software Foundation; either version 2             *
+ * of the License, or (at your option) any later version.                     *
+ *                                                                            *
+ * This program is distributed in the hope that it will be useful,            *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ * GNU General Public License for more details.                               *
+ *                                                                            *
+ * You should have received a copy of the GNU General Public License          *
+ * along with this program; if not, write to the Free Software Foundation     *
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
+ ******************************************************************************/
+
 #ifndef SYSLOGLOGGER_H
 #define SYSLOGLOGGER_H
 
@@ -7,6 +26,8 @@ namespace icinga
 
 /**
  * A logger that logs to syslog.
+ *
+ * @ingroup base
  */
 class I2_BASE_API SyslogLogger : public ILogger
 {

diff --git a/lib/base/tcpserver.h b/lib/base/tcpserver.h
index 3ac03f08fc13f0e007cbf12da27c114ca9089cbb..27aa3e34cdf2f5e569d764cf529def8dc91e891d 100644 (file)
--- a/lib/base/tcpserver.h
+++ b/lib/base/tcpserver.h
@@ -39,7 +39,7 @@ public:
 
        TcpServer(void);
 
-       void SetClientFactory(const ClientFactory& function);
+       void SetClientFactory(const ClientFactory& clientFactory);
        ClientFactory GetFactoryFunction(void) const;
 
        void Listen(void);

diff --git a/lib/base/utility.cpp b/lib/base/utility.cpp
index 710655d90065d92be53fa3b24f21081c97f58217..b64e6b14506aed7759d649f956a52945f50df2e5 100644 (file)
--- a/lib/base/utility.cpp
+++ b/lib/base/utility.cpp
@@ -249,7 +249,7 @@ String Utility::BaseName(const String& path)
 /**
  * Null deleter. Used as a parameter for the shared_ptr constructor.
  *
- * @param -- The object that should be deleted.
+ * @param - The object that should be deleted.
  */
 void Utility::NullDeleter(void *)
 {

diff --git a/lib/base/utility.h b/lib/base/utility.h
index 11687691b3c106068fa03b81a891298640776e9b..7ff9a2ab21c50a6524993f2df848f0a7ff909236 100644 (file)
--- a/lib/base/utility.h
+++ b/lib/base/utility.h
@@ -44,7 +44,7 @@ public:
        static String DirName(const String& path);
        static String BaseName(const String& path);
 
-       static void NullDeleter(void *obj);
+       static void NullDeleter(void *);
 
        static double GetTime(void);
 

diff --git a/lib/base/value.cpp b/lib/base/value.cpp
index f29be13c4d3120cd7c1108413c311c7bf473bd00..f74bb7f3a6e31bd222b2e3843e2e9a15d5ea8cae 100644 (file)
--- a/lib/base/value.cpp
+++ b/lib/base/value.cpp
@@ -133,7 +133,7 @@ cJSON *Value::ToJson(void) const
 /**
  * Deserializes the string representation of a variant.
  *
- * @params jsonString A JSON string obtained from Value::Serialize
+ * @param jsonString A JSON string obtained from Value::Serialize
  * @returns The newly deserialized variant.
  */
 Value Value::Deserialize(const String& jsonString)

diff --git a/lib/config/i2-config.h b/lib/config/i2-config.h
index ce4cd4e69c377898d3e481c895d840297d4a9d3b..868b7e66e4d152c271435cbe1fff6da1721514c2 100644 (file)
--- a/lib/config/i2-config.h
+++ b/lib/config/i2-config.h
@@ -21,10 +21,11 @@
 #define I2CONFIG_H
 
 /**
- * @defgroup config Dynamic object library
+ * @defgroup config Configuration library
  *
- * The dynamic object library implements serializable objects which support
- * inheritance.
+ * The configuration library implements a compiler for Icinga 2's configuration
+ * format. It also provides functionality to create configuration objects
+ * at runtime.
  */
 
 #include <i2-base.h>

diff --git a/lib/icinga/cib.h b/lib/icinga/cib.h
index f9353cda7309ffcef1d2452d17b215b2d677c23e..fc4bc53925b2ecd33367a2ddf27cccc503010ee7 100644 (file)
--- a/lib/icinga/cib.h
+++ b/lib/icinga/cib.h
@@ -23,6 +23,12 @@
 namespace icinga
 {
 
+/**
+ * Common Information Base class. Holds some statistics (and will likely be
+ * removed/refactored).
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API CIB
 {
 public:

diff --git a/lib/icinga/host.h b/lib/icinga/host.h
index 1c130befe9aa2cea7c9798b4a5f8c89708ce68c0..26d06bac09930b9109549e9db9c6b315de02d4bf 100644 (file)
--- a/lib/icinga/host.h
+++ b/lib/icinga/host.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * An Icinga host.
+ * 
+ * @ingroup icinga
+ */
 class I2_ICINGA_API Host : public DynamicObject
 {
 public:

diff --git a/lib/icinga/hostgroup.h b/lib/icinga/hostgroup.h
index 29303da088d4024a13804b76502db455ca40b835..b0e85410378ed8ef9a21cb16067bc7cdf7919141 100644 (file)
--- a/lib/icinga/hostgroup.h
+++ b/lib/icinga/hostgroup.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * An Icinga host group.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API HostGroup : public DynamicObject
 {
 public:

diff --git a/lib/icinga/i2-icinga.h b/lib/icinga/i2-icinga.h
index 6e4ec6c81b635191b0d4416af799e91403e52b78..d5f8e27666ff301446534b5d957d9c384b27f0a8 100644 (file)
--- a/lib/icinga/i2-icinga.h
+++ b/lib/icinga/i2-icinga.h
@@ -21,10 +21,10 @@
 #define I2ICINGA_H
 
 /**
- * @defgroup icinga Icinga application
+ * @defgroup icinga Icinga library
  *
- * The Icinga application is in charge of boot-strapping the Icinga
- * environment and loading additional components.
+ * The Icinga library implements all Icinga-specific functionality that is
+ * common to all components (e.g. hosts, services, etc.).
  */
 
 #include <i2-base.h>

diff --git a/lib/icinga/macroprocessor.h b/lib/icinga/macroprocessor.h
index 3f430f7ab4a51d382f4acdf40e1efbae39878119..e015e9e8206c5ae0d05a932a439172c9867b2efe 100644 (file)
--- a/lib/icinga/macroprocessor.h
+++ b/lib/icinga/macroprocessor.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * Resolves macros.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API MacroProcessor
 {
 public:

diff --git a/lib/icinga/nagioschecktask.h b/lib/icinga/nagioschecktask.h
index ce6e575cf5eba331643f71c9cc79889f315a4851..c23cb1476b8ae726cf2e14e8ab63838830c8510a 100644 (file)
--- a/lib/icinga/nagioschecktask.h
+++ b/lib/icinga/nagioschecktask.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * Implements Nagios(TM)-style checks.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API NagiosCheckTask
 {
 public:

diff --git a/lib/icinga/nullchecktask.h b/lib/icinga/nullchecktask.h
index d9a0a59adf245bbad725d2313b8fa9696f08f16d..13b268180e94f32b7e31b4cb93639bedf719373c 100644 (file)
--- a/lib/icinga/nullchecktask.h
+++ b/lib/icinga/nullchecktask.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * Test class for additional check types. Implements the "null" check type.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API NullCheckTask
 {
 public:

diff --git a/lib/icinga/service.h b/lib/icinga/service.h
index 92c22ea18d38973a8727a19fd8d310547410ecc1..8391cd6b6f5034b8478801dd09e6dba94a45e53c 100644 (file)
--- a/lib/icinga/service.h
+++ b/lib/icinga/service.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * The state of a service.
+ *
+ * @ingroup icinga
+ */
 enum ServiceState
 {
        StateOK,
@@ -32,6 +37,11 @@ enum ServiceState
        StateUncheckable,
 };
 
+/**
+ * The state type of a service.
+ *
+ * @ingroup icinga
+ */
 enum ServiceStateType
 {
        StateTypeSoft,
@@ -41,6 +51,11 @@ enum ServiceStateType
 class CheckResultMessage;
 class ServiceStatusMessage;
 
+/**
+ * An Icinga service.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API Service : public DynamicObject
 {
 public:

diff --git a/lib/icinga/servicegroup.h b/lib/icinga/servicegroup.h
index 9552e29a2ded11cfe5b3d963e5ff72ba4d23253b..48f2c4f6e7e2c7cdc113f2768521efb1d9e33a47 100644 (file)
--- a/lib/icinga/servicegroup.h
+++ b/lib/icinga/servicegroup.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * An Icinga service group.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API ServiceGroup : public DynamicObject
 {
 public:

diff --git a/lib/icinga/servicestatechangemessage.h b/lib/icinga/servicestatechangemessage.h
index 575855c2b9d3ae656da60c598228e8be59307c9e..be8733db29dd36accd1a1ce9a31a9862c51b18da 100644 (file)
--- a/lib/icinga/servicestatechangemessage.h
+++ b/lib/icinga/servicestatechangemessage.h
@@ -23,6 +23,11 @@
 namespace icinga
 {
 
+/**
+ * A state change message for a service.
+ *
+ * @ingroup icinga
+ */
 class I2_ICINGA_API ServiceStateChangeMessage : public MessagePart
 {
 public:

diff --git a/lib/remoting/endpoint.h b/lib/remoting/endpoint.h
index b037782532f02ac4b890ef466516c17bb0484df2..bfa6a92361f467a653b6d7544c5c765871b3411a 100644 (file)
--- a/lib/remoting/endpoint.h
+++ b/lib/remoting/endpoint.h
@@ -28,7 +28,7 @@ class EndpointManager;
 /**
  * An endpoint that can be used to send and receive messages.
  *
- * @ingroup icinga
+ * @ingroup remoting
  */
 class I2_REMOTING_API Endpoint : public DynamicObject
 {

diff --git a/lib/remoting/endpointmanager.h b/lib/remoting/endpointmanager.h
index 9796dd8e53c72b7f3918ab1b82db3718bce11f92..878cf368e8e89ed9b096d3dddbe6ce5afeffe3db 100644 (file)
--- a/lib/remoting/endpointmanager.h
+++ b/lib/remoting/endpointmanager.h
@@ -26,7 +26,7 @@ namespace icinga
 /**
  * Forwards messages between endpoints.
  *
- * @ingroup icinga
+ * @ingroup remoting
  */
 class I2_REMOTING_API EndpointManager : public Object
 {
@@ -56,10 +56,6 @@ public:
 
        void ProcessResponseMessage(const Endpoint::Ptr& sender, const ResponseMessage& message);
 
-//     void ForEachEndpoint(function<void (const EndpointManager::Ptr&, const Endpoint::Ptr&)> callback);
-//     Iterator Begin(void);
-//     Iterator End(void);
-
        boost::signal<void (const EndpointManager::Ptr&, const Endpoint::Ptr&)> OnNewEndpoint;
 
 private:
@@ -78,7 +74,7 @@ private:
        /**
         * Information about a pending API request.
         *
-        * @ingroup icinga
+        * @ingroup remoting
         */
        struct I2_REMOTING_API PendingRequest
        {

diff --git a/lib/remoting/i2-remoting.h b/lib/remoting/i2-remoting.h
index a54d94350f81f599409c6ba14a513c6ca7dcc612..132a2314bbdcb3345e133acd04270ac3a9a158e4 100644 (file)
--- a/lib/remoting/i2-remoting.h
+++ b/lib/remoting/i2-remoting.h
@@ -21,10 +21,10 @@
 #define I2REMOTING_H
 
 /**
- * @defgroup remoting JSON-RPC library
+ * @defgroup remoting Remoting library
  *
- * The JSON-RPC library implements server and client classes for the JSON-RPC
- * protocol.
+ * Implements server and client classes for the JSON-RPC protocol. Also
+ * supports endpoint-based communication using messages.
  */
 
 #include <i2-base.h>

diff --git a/lib/remoting/messagepart.cpp b/lib/remoting/messagepart.cpp
index 7c04a951a8b9b13770b4af1ee26073eb272314ea..f5a5280da98f646d8c4e867ea0d4286bc10d0fe3 100644 (file)
--- a/lib/remoting/messagepart.cpp
+++ b/lib/remoting/messagepart.cpp
@@ -63,7 +63,7 @@ Dictionary::Ptr MessagePart::GetDictionary(void) const
  * Retrieves a property's value.
  *
  * @param key The name of the property.
- * @param[out] The value.
+ * @param[out] value The value.
  * @returns true if the value was retrieved, false otherwise.
  */
 bool MessagePart::Get(String key, MessagePart *value) const

diff --git a/lib/remoting/messagepart.h b/lib/remoting/messagepart.h
index defff4357f516e57b93ec43f20c34b595548e14b..f7a4f819df0d634a8f1cded269f37c679882a813 100644 (file)
--- a/lib/remoting/messagepart.h
+++ b/lib/remoting/messagepart.h
@@ -45,7 +45,7 @@ public:
         * Retrieves a property's value.
         *
         * @param key The name of the property.
-        * @param[out] The value.
+        * @param[out] value The value.
         * @returns true if the value was retrieved, false otherwise.
         */
        template<typename T>