mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-23 20:46:14 +01:00
docs: Move the GUuid SECTION
Move it to a separate page as there’s no public struct to hang the docs off. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3037
This commit is contained in:
parent
be783fdc2a
commit
359c1034e0
@ -69,6 +69,7 @@ content_files = [
|
|||||||
"base64.md",
|
"base64.md",
|
||||||
"goption.md",
|
"goption.md",
|
||||||
"data-structures.md",
|
"data-structures.md",
|
||||||
|
"uuid.md",
|
||||||
"unicode.md",
|
"unicode.md",
|
||||||
|
|
||||||
"threads-deprecated.md",
|
"threads-deprecated.md",
|
||||||
|
@ -169,6 +169,7 @@ expand_content_files = [
|
|||||||
'goption.md',
|
'goption.md',
|
||||||
'data-structures.md',
|
'data-structures.md',
|
||||||
'unicode.md',
|
'unicode.md',
|
||||||
|
'uuid.md',
|
||||||
]
|
]
|
||||||
|
|
||||||
glib_toml = configure_file(input: 'glib.toml.in', output: 'glib.toml', configuration: toml_conf)
|
glib_toml = configure_file(input: 'glib.toml.in', output: 'glib.toml', configuration: toml_conf)
|
||||||
|
25
docs/reference/glib/uuid.md
Normal file
25
docs/reference/glib/uuid.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
Title: GUuid
|
||||||
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
||||||
|
SPDX-FileCopyrightText: 2017 Bastien Nocera
|
||||||
|
SPDX-FileCopyrightText: 2017 Marc-André Lureau
|
||||||
|
|
||||||
|
# GUuid
|
||||||
|
|
||||||
|
A UUID, or Universally unique identifier, is intended to uniquely
|
||||||
|
identify information in a distributed environment. For the
|
||||||
|
definition of UUID, see [RFC 4122](https://tools.ietf.org/html/rfc4122.html).
|
||||||
|
|
||||||
|
The creation of UUIDs does not require a centralized authority.
|
||||||
|
|
||||||
|
UUIDs are of relatively small size (128 bits, or 16 bytes). The
|
||||||
|
common string representation (ex:
|
||||||
|
`1d6c0810-2bd6-45f3-9890-0268422a6f14`) needs 37 bytes.
|
||||||
|
[func@GLib.uuid_string_is_valid] can be used to check whether a string is a
|
||||||
|
valid UUID.
|
||||||
|
|
||||||
|
The UUID specification defines 5 versions, and calling
|
||||||
|
[func@GLib.uuid_string_random] will generate a unique (or rather random)
|
||||||
|
UUID of the most common version, version 4.
|
||||||
|
|
||||||
|
UUID support was added to GLib in version 2.52.
|
||||||
|
|
22
glib/guuid.c
22
glib/guuid.c
@ -35,28 +35,6 @@ typedef struct {
|
|||||||
guint8 bytes[16];
|
guint8 bytes[16];
|
||||||
} GUuid;
|
} GUuid;
|
||||||
|
|
||||||
/**
|
|
||||||
* SECTION:uuid
|
|
||||||
* @title: GUuid
|
|
||||||
* @short_description: a universally unique identifier
|
|
||||||
*
|
|
||||||
* A UUID, or Universally unique identifier, is intended to uniquely
|
|
||||||
* identify information in a distributed environment. For the
|
|
||||||
* definition of UUID, see [RFC 4122](https://tools.ietf.org/html/rfc4122.html).
|
|
||||||
*
|
|
||||||
* The creation of UUIDs does not require a centralized authority.
|
|
||||||
*
|
|
||||||
* UUIDs are of relatively small size (128 bits, or 16 bytes). The
|
|
||||||
* common string representation (ex:
|
|
||||||
* 1d6c0810-2bd6-45f3-9890-0268422a6f14) needs 37 bytes.
|
|
||||||
*
|
|
||||||
* The UUID specification defines 5 versions, and calling
|
|
||||||
* g_uuid_string_random() will generate a unique (or rather random)
|
|
||||||
* UUID of the most common version, version 4.
|
|
||||||
*
|
|
||||||
* Since: 2.52
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* g_uuid_to_string:
|
* g_uuid_to_string:
|
||||||
* @uuid: a #GUuid
|
* @uuid: a #GUuid
|
||||||
|
Loading…
Reference in New Issue
Block a user