]> granicus.if.org Git - icinga2/commitdiff
Documentation updates.
authorGunnar Beutner <gunnar@beutner.name>
Fri, 18 May 2012 21:24:00 +0000 (23:24 +0200)
committerGunnar Beutner <gunnar@beutner.name>
Fri, 18 May 2012 21:24:00 +0000 (23:24 +0200)
Doxyfile.in
base/tcpclient.h
base/variant.h
icinga/i2-icinga.h
jsonrpc/netstring.h

index 4165dfe7e426e21638d5e67179d93f12d6272482..dc9b0b584b4dcab9dbea8ee82e15296071b915d9 100644 (file)
@@ -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
index 170c1934678f3c3f4d0a13b880e1374066fe86be..80f6cf2525b6ffa4b9fdc8382104cd24992ffae8 100644 (file)
@@ -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. */
 };
 
 /**
index 971f66e6a90083a014c401a8d4e524f1e9e22ca3..91a212b7c78f9ecc234bb958ad5011bc48d48d69 100644 (file)
@@ -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. */
 };
 
 /**
index b29133be465d503cecdafb23ff0cbb0da9b37496..67a7859536db9b53a887d4671afdae5163b0e45c 100644 (file)
@@ -21,7 +21,7 @@
 #define I2ICINGA_H
 
 /**
- * @defgroup icinga
+ * @defgroup icinga Icinga application
  */
 
 #include <i2-base.h>
index 5fc1087ebb8a9b8239f8f9392972fe0215a7b88c..f696db6baf2580c0b617575ed1e92a02526df927 100644 (file)
@@ -25,6 +25,8 @@ namespace icinga
 
 /**
  * Thrown when an invalid netstring was encountered while reading from a FIFO.
+ *
+ * @ingroup jsonrpc
  */
 DEFINE_EXCEPTION_CLASS(InvalidNetstringException);