mirror of https://github.com/Icinga/icinga2.git
Documentation updates.
This commit is contained in:
parent
d02dd4eb0a
commit
fcb0394329
|
@ -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
|
||||
|
|
|
@ -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. */
|
||||
};
|
||||
|
||||
/**
|
||||
|
|
|
@ -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. */
|
||||
};
|
||||
|
||||
/**
|
||||
|
|
|
@ -21,7 +21,7 @@
|
|||
#define I2ICINGA_H
|
||||
|
||||
/**
|
||||
* @defgroup icinga
|
||||
* @defgroup icinga Icinga application
|
||||
*/
|
||||
|
||||
#include <i2-base.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);
|
||||
|
||||
|
|
Loading…
Reference in New Issue