Commit 273cbd00 authored by Philipp Schafft's avatar Philipp Schafft 🦁
Browse files

Feature: Added docu for igloo_uuid_new_random_sp(), and igloo_uuid_new_random_cstr()

parent cba77dbc
......@@ -25,7 +25,38 @@ extern "C" {
#include <igloo/types.h>
/* Creates a new random UUID (v4).
*
* This function generates a new random UUID providing a string pool reference.
* This is the preferred way of working with string based UUIDs as it allows the reference to travel.
* The reference must be freed with igloo_sp_unref().
*
* Parameters:
* ref
* instance
* Reference and instance as used by igloo_sp_replace().
*
* See also:
* * igloo_sp_replace().
*/
igloo_error_t igloo_uuid_new_random_sp(const char **ref, igloo_ro_t instance) igloo_ATTR_F_WARN_UNUSED_RESULT;
/* Creates a new random UUID (v4).
*
* This function generates a new random UUID providing a bare C string.
* The string must later be freed with free(3).
*
* Parameters:
* ref
* A pointer to a C string. The C string MUST be NULL when this function is called. It will be updated
* to a newly created C string containing the UUID. It must be freed with free(3).
* instance
* The instance to use for the generation process.
* The instance may be un-referenced before the provided C string is free(3)ed.
*
* See also:
* * igloo_uuid_new_random_sp().
*/
igloo_error_t igloo_uuid_new_random_cstr(char **str, igloo_ro_t instance) igloo_ATTR_F_WARN_UNUSED_RESULT;
#ifdef __cplusplus
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment