diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/kiro-sb.h | 14 | ||||
| -rw-r--r-- | src/kiro-server.h | 8 | ||||
| -rw-r--r-- | src/kiro-trb.h | 17 |
3 files changed, 23 insertions, 16 deletions
diff --git a/src/kiro-sb.h b/src/kiro-sb.h index 4736c75..a2b8604 100644 --- a/src/kiro-sb.h +++ b/src/kiro-sb.h @@ -181,9 +181,9 @@ void kiro_sb_clear_sync_callbacks (KiroSb *sb); * kiro_sb_serve: * @sb: (transfer none): The #KiroSb to perform this operation on * @size: Size in bytes of the content that will be served - * @addr: Optional address parameter to define where to listen for new - * connections. - * @port: Optional port to listen on for new connections + * @addr: (transfer none): Optional address parameter to define where to + * listen for new connections. + * @port: (transfer none): Optional port to listen on for new connections * * Allows other remote #KiroSbs to connect to this #KiroSb and clone its * memory. The internal memory is initially empty. Use the kiro_sb_push or @@ -206,8 +206,10 @@ gboolean kiro_sb_serve (KiroSb *sb, gulong size, const gchar *addr, /** * kiro_sb_clone: * @sb: (transfer none): The #KiroSb to perform this operation on - * @address: The InfiniBand address of the remote #KiroSb which should be cloned - * @port: The InfiniBand port of the remote #KiroSb which should be cloned + * @address: (transfer none): The InfiniBand address of the remote #KiroSb + * which should be cloned + * @port: (transfer none): The InfiniBand port of the remote #KiroSb which + * should be cloned * * Connects to the remote #KiroSb given by @address and @port and * continuousely clones its content into the local #KiroSb @@ -303,7 +305,7 @@ void* kiro_sb_get_data_blocking (KiroSb *sb); /** * kiro_sb_push: * @sb: (transfer none) The #KiroSb to get the data from - * @data: (transfer none) void pointer to copy data from + * @data: (transfer none) (type gulong): void pointer to copy data from * * Updates the internal memory by memcopy()-ing the given element into it. * This operation is only valid for 'serving' #KiroSb. Calling this function diff --git a/src/kiro-server.h b/src/kiro-server.h index 8479e15..c6d5fe8 100644 --- a/src/kiro-server.h +++ b/src/kiro-server.h @@ -98,9 +98,9 @@ void kiro_server_free (KiroServer *server); /** * kiro_server_start: * @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: (transfer none): Pointer to the memory that is to be provided + * @bind_addr (transfer none): Local address to bind the server to + * @bind_port (transfer none): Local port to listen for connections + * @mem: (transfer none) (type gulong): Pointer to the memory that is to be provided * @mem_size: Size in bytes of the given memory * * Starts the #KiroServer to provide the given memory to any connecting @@ -124,7 +124,7 @@ int kiro_server_start (KiroServer *server, const char *bind_addr, const char *bi /** * kiro_server_realloc: * @server: #KiroServer to perform the operation on - * @mem: (transfer none): Pointer to the memory that is to be provided + * @mem: (transfer none) (type gulong): Pointer to the memory that is to be provided * @mem_size: Size in bytes of the given memory * * Changes the memory that is provided by the server. All connected clients diff --git a/src/kiro-trb.h b/src/kiro-trb.h index 3549a1d..779aae9 100644 --- a/src/kiro-trb.h +++ b/src/kiro-trb.h @@ -150,7 +150,7 @@ uint64_t kiro_trb_get_raw_size (KiroTrb *trb); * * Returns a pointer to the memory structure of the given buffer. * - * Returns: (transfer none): a pointer to the buffer memory + * Returns: (transfer none) (type gulong): a pointer to the buffer memory * Notes: * The returned pointer points to the beginning of the internal * memory of the buffer, including all header information. The @@ -177,7 +177,8 @@ void* kiro_trb_get_raw_buffer (KiroTrb *trb); * * Returns a pointer to the element in the buffer at the given index. * - * Returns: (transfer none): a pointer to the element at the given index. + * Returns: (transfer none) (type gulong): + * A pointer to the element at the given index. * Notes: * The returned pointer to the element is only guaranteed to be valid * immediately after the function call. The user is responsible to @@ -203,7 +204,8 @@ void* kiro_trb_get_element (KiroTrb *trb, glong index); * all internal counters and meta data as if an element was pushed * onto the buffer. * - * Returns: (transfer none): Pointer to the bginning of element memory + * Returns: (transfer none) (type gulong): + * Pointer to the bginning of element memory * Notes: * The returned pointer to the element is only guaranteed to be valid * immediately after the function call. The user is responsible to @@ -298,7 +300,8 @@ int kiro_trb_reshape (KiroTrb *trb, uint64_t element_size, uint64_t element_coun /** * kiro_trb_clone: * @trb: (transfer none); #KiroTrb to perform the operation on - * @source: Pointer to the source memory to clone from + * @source: (transfer none) (type gulong): + * Pointer to the source memory to clone from * * Interprets the given memory as a pointer to another KIRO TRB and * tries to copy that memory into its own. @@ -321,7 +324,8 @@ int kiro_trb_clone (KiroTrb *trb, void *source); /** * kiro_trb_push: * @trb: (transfer none): #KiroTrb to perform the operation on - * @source: Pointer to the memory of the element to add + * @source: (transfer none) (type gulong): + * Pointer to the memory of the element to add * * Copies the given element and adds it into the buffer * @@ -361,7 +365,8 @@ void kiro_trb_refresh (KiroTrb *trb); /** * kiro_trb_adopt: * @trb: (transfer none): #KiroTrb to perform the operation on - * @source: Pointer to the source memory to adopt + * @source: (transfer full) (type gulong): + * Pointer to the source memory to adopt * * Interprets the given memory as a pointer to another KIRO TRB and * takes ownership over the memory. |