From fcb0394329b5d747b500294a3c6a2ff39c21fa87 Mon Sep 17 00:00:00 2001 From: Gunnar Beutner Date: Fri, 18 May 2012 23:24:00 +0200 Subject: [PATCH] Documentation updates. --- Doxyfile.in | 2 +- base/tcpclient.h | 8 +++++--- base/variant.h | 11 ++++++----- icinga/i2-icinga.h | 2 +- jsonrpc/netstring.h | 2 ++ 5 files changed, 15 insertions(+), 10 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index 4165dfe7e..dc9b0b584 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -151,7 +151,7 @@ SHORT_NAMES = NO # comments will behave just like regular Qt-style comments # (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 # interpret the first line (until the first dot) of a Qt-style diff --git a/base/tcpclient.h b/base/tcpclient.h index 170c19346..80f6cf252 100644 --- a/base/tcpclient.h +++ b/base/tcpclient.h @@ -28,10 +28,12 @@ namespace icinga * * @ingroup base */ -enum I2_BASE_API TCPClientRole +enum TCPClientRole { - RoleInbound, /**< inbound socket, i.e. one that was returned from accept() */ - RoleOutbound /**< outbound socket, i.e. one that is connect()'d to a remote socket */ + RoleInbound, /**< Inbound socket, i.e. one that was returned + from accept(). */ + RoleOutbound /**< Outbound socket, i.e. one that is connect()'d to a + remote socket. */ }; /** diff --git a/base/variant.h b/base/variant.h index 971f66e6a..91a212b7c 100644 --- a/base/variant.h +++ b/base/variant.h @@ -28,12 +28,13 @@ namespace icinga * * @ingroup base */ -enum I2_BASE_API VariantType +enum VariantType { - VariantEmpty, - VariantInteger, - VariantString, - VariantObject + VariantEmpty, /**< Denotes that the Variant is empty. */ + VariantInteger, /**< Denotes that the Variant is holding an integer. */ + VariantString, /**< Denotes that the Variant is holding a string. */ + VariantObject /**< Denotes that the Variant is holding an object + that inherits from the Object class. */ }; /** diff --git a/icinga/i2-icinga.h b/icinga/i2-icinga.h index b29133be4..67a785953 100644 --- a/icinga/i2-icinga.h +++ b/icinga/i2-icinga.h @@ -21,7 +21,7 @@ #define I2ICINGA_H /** - * @defgroup icinga + * @defgroup icinga Icinga application */ #include diff --git a/jsonrpc/netstring.h b/jsonrpc/netstring.h index 5fc1087eb..f696db6ba 100644 --- a/jsonrpc/netstring.h +++ b/jsonrpc/netstring.h @@ -25,6 +25,8 @@ namespace icinga /** * Thrown when an invalid netstring was encountered while reading from a FIFO. + * + * @ingroup jsonrpc */ DEFINE_EXCEPTION_CLASS(InvalidNetstringException); -- 2.40.0