Documentation updates.

This commit is contained in:
Gunnar Beutner 2012-05-18 23:24:00 +02:00
parent d02dd4eb0a
commit fcb0394329
5 changed files with 15 additions and 10 deletions

View File

@ -151,7 +151,7 @@ SHORT_NAMES = NO
# comments will behave just like regular Qt-style comments # comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.) # (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style # interpret the first line (until the first dot) of a Qt-style

View File

@ -28,10 +28,12 @@ namespace icinga
* *
* @ingroup base * @ingroup base
*/ */
enum I2_BASE_API TCPClientRole enum TCPClientRole
{ {
RoleInbound, /**< inbound socket, i.e. one that was returned from accept() */ RoleInbound, /**< Inbound socket, i.e. one that was returned
RoleOutbound /**< outbound socket, i.e. one that is connect()'d to a remote socket */ from accept(). */
RoleOutbound /**< Outbound socket, i.e. one that is connect()'d to a
remote socket. */
}; };
/** /**

View File

@ -28,12 +28,13 @@ namespace icinga
* *
* @ingroup base * @ingroup base
*/ */
enum I2_BASE_API VariantType enum VariantType
{ {
VariantEmpty, VariantEmpty, /**< Denotes that the Variant is empty. */
VariantInteger, VariantInteger, /**< Denotes that the Variant is holding an integer. */
VariantString, VariantString, /**< Denotes that the Variant is holding a string. */
VariantObject VariantObject /**< Denotes that the Variant is holding an object
that inherits from the Object class. */
}; };
/** /**

View File

@ -21,7 +21,7 @@
#define I2ICINGA_H #define I2ICINGA_H
/** /**
* @defgroup icinga * @defgroup icinga Icinga application
*/ */
#include <i2-base.h> #include <i2-base.h>

View File

@ -25,6 +25,8 @@ namespace icinga
/** /**
* Thrown when an invalid netstring was encountered while reading from a FIFO. * Thrown when an invalid netstring was encountered while reading from a FIFO.
*
* @ingroup jsonrpc
*/ */
DEFINE_EXCEPTION_CLASS(InvalidNetstringException); DEFINE_EXCEPTION_CLASS(InvalidNetstringException);