From 8b0c102cac8625753ca10d85009ac8b57c850ba3 Mon Sep 17 00:00:00 2001
From: Gunnar Beutner <gunnar.beutner@netways.de>
Date: Fri, 18 May 2012 23:25:06 +0200
Subject: [PATCH] More documentation updates.

---
 base/memory.cpp            | 10 ++++++----
 base/memory.h              |  2 +-
 base/utility.h             |  7 +++++--
 icinga/endpointmanager.cpp |  6 +++---
 jsonrpc/netstring.h        |  2 +-
 5 files changed, 16 insertions(+), 11 deletions(-)

diff --git a/base/memory.cpp b/base/memory.cpp
index be0ba2e59..193a0a53a 100644
--- a/base/memory.cpp
+++ b/base/memory.cpp
@@ -29,11 +29,11 @@ Memory::Memory(void)
 }
 
 /**
- * Allocates memory. Throws an exception if no memory is available. Alignment
- * guarantees are the same like for malloc().
+ * Allocates memory. Alignment guarantees are the same like for malloc().
  *
  * @param size The size of the requested memory block.
  * @returns A new block of memory.
+ * @exception OutOfMemoryException No more memory is available.
  */
 void *Memory::Allocate(size_t size)
 {
@@ -46,11 +46,12 @@ void *Memory::Allocate(size_t size)
 }
 
 /**
- * Resizes a block of memory. Throws an exception if no memory is available.
+ * Resizes a block of memory.
  *
  * @param ptr The old memory block or NULL.
  * @param size The requested new size of the block.
  * @returns A pointer to the new memory block.
+ * @exception OutOfMemoryException No more memory is available.
  */
 void *Memory::Reallocate(void *ptr, size_t size)
 {
@@ -63,10 +64,11 @@ void *Memory::Reallocate(void *ptr, size_t size)
 }
 
 /**
- * Duplicates a string. Throws an exception if no memory is available.
+ * Duplicates a string.
  *
  * @param str The string.
  * @returns A copy of the string.
+ * @exception OutOfMemoryException No more memory is available.
  */
 char *Memory::StrDup(const char *str)
 {
diff --git a/base/memory.h b/base/memory.h
index fc3f2dec8..7fe44cc81 100644
--- a/base/memory.h
+++ b/base/memory.h
@@ -26,7 +26,7 @@ namespace icinga
 DEFINE_EXCEPTION_CLASS(OutOfMemoryException);
 
 /**
- * Singleton class which implements memory allocation helpers.
+ * Memory allocation helper functions.
  *
  * @ingroup base
  */
diff --git a/base/utility.h b/base/utility.h
index f2a65fbc3..2769bdd8f 100644
--- a/base/utility.h
+++ b/base/utility.h
@@ -24,7 +24,7 @@ namespace icinga
 {
 
 /**
- * Utility functions.
+ * Helper functions.
  *
  * @ingroup base
  */
@@ -39,7 +39,10 @@ private:
 
 public:
 	/**
-	 * Returns the type name of an object (using RTTI).
+	 * Returns a human-readable type name of an object (using RTTI).
+	 *
+	 * @param value An object.
+	 * @returns The type name of the object.
 	 */
 	template<class T>
 	static string GetTypeName(const T& value)
diff --git a/icinga/endpointmanager.cpp b/icinga/endpointmanager.cpp
index bb2736199..612e0ca30 100644
--- a/icinga/endpointmanager.cpp
+++ b/icinga/endpointmanager.cpp
@@ -65,7 +65,7 @@ shared_ptr<SSL_CTX> EndpointManager::GetSSLContext(void) const
 /**
  * Creates a new JSON-RPC listener on the specified port.
  *
- * @param service The name of the service to listen on (@see getaddrinfo).
+ * @param service The port to listen on.
  */
 void EndpointManager::AddListener(string service)
 {
@@ -87,8 +87,8 @@ void EndpointManager::AddListener(string service)
 /**
  * Creates a new JSON-RPC client and connects to the specified host and port.
  *
- * @param node The remote host (@see getaddrinfo).
- * @param service The remote port (@see getaddrinfo).
+ * @param node The remote host.
+ * @param service The remote port.
  */
 void EndpointManager::AddConnection(string node, string service)
 {
diff --git a/jsonrpc/netstring.h b/jsonrpc/netstring.h
index f696db6ba..eb1da9765 100644
--- a/jsonrpc/netstring.h
+++ b/jsonrpc/netstring.h
@@ -31,7 +31,7 @@ namespace icinga
 DEFINE_EXCEPTION_CLASS(InvalidNetstringException);
 
 /**
- * Utility functions for reading/writing messages in the netstring format.
+ * Helper functions for reading/writing messages in the netstring format.
  * See http://cr.yp.to/proto/netstrings.txt for details.
  *
  * @ingroup jsonrpc