From 5235e634860744f0b1251b0e50e89446f93381c2 Mon Sep 17 00:00:00 2001
From: Timo Dritschler <timo.dritschler@kit.edu>
Date: Fri, 21 Nov 2014 17:54:13 +0100
Subject: Fix #1: Added missing documentation to TRB, Client and Server header
 Fixed build warnings Fixed a bug in kiro-test-bandwidth

---
 src/kiro-server.h | 35 ++++++++++++++++++++++++++++++-----
 1 file changed, 30 insertions(+), 5 deletions(-)

(limited to 'src/kiro-server.h')

diff --git a/src/kiro-server.h b/src/kiro-server.h
index 78b2cf4..7e42159 100644
--- a/src/kiro-server.h
+++ b/src/kiro-server.h
@@ -70,10 +70,36 @@ struct _KiroServerClass {
 
 
 /* GObject and GType functions */
+
+/**
+ * kiro_server_get_type: (skip)
+ * Returns: GType of KiroServer
+ */
 GType        kiro_server_get_type            (void);
 
-KiroServer   *kiro_server_new                (void);
+/**
+ * kiro_server_new - Creates a new #KiroServer
+ * Returns: (transfer full): A pointer to a new #KiroServer
+ * Description:
+ *   Creates a new, unbound #KiroServer and returns a pointer to it.
+ * See also:
+ *   kiro_server_start, kiro_server_free
+ */
+KiroServer*  kiro_server_new                (void);
 
+/**
+ * kiro_server_free - 'Destroys' the given #KiroServer
+ * @server: The #KiroServer that is to be freed
+ * Description:
+ *   Transitions the #KiroServer through all necessary shutdown routines and
+ *   frees the object memory.
+ * Note:
+ *   The memory that is given to the server when calling kiro_server_start will
+ *   NOT be freed! The user is responsible to free this memory, if no longer
+ *   needed.
+ * See also:
+ *   kiro_server_start, kiro_server_new
+ */
 void         kiro_server_free                (KiroServer *server);
 
 
@@ -84,7 +110,7 @@ void         kiro_server_free                (KiroServer *server);
  * @server: #KiroServer to perform the operation on
  * @bind_addr: Local address to bind the server to
  * @bind_port: Local port to listen for connections
- * @mem: Pointer to the memory that is to be provided
+ * @mem: (transfer none): Pointer to the memory that is to be provided
  * @mem_size: Size in bytes of the given memory
  * Description:
  *   Starts the #KiroServer to provide the given memory to any connecting
@@ -99,10 +125,9 @@ void         kiro_server_free                (KiroServer *server);
  *   and return the chosen port as return value.
  *   If server creation fails, -1 is returned instead.
  * See also:
- *   kiro_trb_reshape, kiro_trb_adopt,
- *   kiro_trb_clone
+ *   kiro_server_new,
  */
-int kiro_server_start (KiroServer *server, char *bind_addr, char *bind_port, void *mem, size_t mem_size);
+int kiro_server_start (KiroServer *server, const char *bind_addr, const char *bind_port, void *mem, size_t mem_size);
 
 /**
  * kiro_server_stop - Stops the server
-- 
cgit v1.2.3