mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-26 21:22:20 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Cleanup uuid documentation

Browse source
This commit is contained in:
Ulrich Küttler 2015-02-16 15:12:33 +01:00
parent ed896ca21c
commit 05c4b71b87
1 changed files with 35 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

54
std/uuid.d
View file

@ -12,19 +12,37 @@ $(DIVC quickindex,
$(BOOKTABLE ,
$(TR $(TH Category) $(TH Functions)
)
$(TR $(TDNW Parsing UUIDs) $(TD $(MYREF parseUUID) $(MYREF
UUID(string)) $(MYREF UUIDParsingException) $(MYREF uuidRegex) )
)
$(TR $(TDNW Generating UUIDs) $(TD $(MYREF sha1UUID) $(MYREF randomUUID) $(MYREF
md5UUID))
)
$(TR $(TDNW Using UUIDs) $(TD $(MYREF2 UUID.uuidVersion, uuidVersion) $(MYREF2 UUID.variant, variant)
$(MYREF2 UUID.toString, toString) $(MYREF2 UUID.data, data) $(MYREF2 UUID.swap, swap)
$(MYREF2 UUID.opEquals, opEquals) $(MYREF2 UUID.opCmp, opCmp) $(MYREF2 UUID.toHash, toHash) )
)
$(TR $(TDNW UUID namespaces) $(TD $(MYREF dnsNamespace) $(MYREF urlNamespace)
$(MYREF oidNamespace) $(MYREF x500Namespace) )
)
$(TR $(TDNW Parsing UUIDs)
$(TD $(MYREF parseUUID)
$(MYREF UUID)
$(MYREF UUIDParsingException)
$(MYREF uuidRegex)
)
)
$(TR $(TDNW Generating UUIDs)
$(TD $(MYREF sha1UUID)
$(MYREF randomUUID)
$(MYREF md5UUID)
)
)
$(TR $(TDNW Using UUIDs)
$(TD $(MYREF2 UUID.uuidVersion, uuidVersion)
$(MYREF2 UUID.variant, variant)
$(MYREF2 UUID.toString, toString)
$(MYREF2 UUID.data, data)
$(MYREF2 UUID.swap, swap)
$(MYREF2 UUID.opEquals, opEquals)
$(MYREF2 UUID.opCmp, opCmp)
$(MYREF2 UUID.toHash, toHash)
)
)
$(TR $(TDNW UUID namespaces)
$(TD $(MYREF dnsNamespace)
$(MYREF urlNamespace)
$(MYREF oidNamespace)
$(MYREF x500Namespace)
)
)
)
)
@ -90,7 +108,7 @@ $(MYREF oidNamespace) $(MYREF x500Namespace) )
* Source: $(PHOBOSSRC std/_uuid.d)
*
* Macros:
* MYREF2 = <font face='Consolas, "Bitstream Vera Sans Mono", "Andale Mono", Monaco, "DejaVu Sans Mono", "Lucida Console", monospace'><a href="#$2">$1</a>&nbsp;</font>
* MYREF2 = <a href="#$2">$(TT $1)</a>&nbsp;
* MYREF3 = <a href="#$2">$(D $1)</a>
*/
/* Copyright Johannes Pfau 2011 - 2012.
@ -156,8 +174,7 @@ public struct UUID
* possible to read, compare and use all these Variants, but
* UUIDs generated by this module will always be in rfc4122 format.
*
* Note: Do not confuse this with $(XREF _variant, _Variant). This has nothing
* to do with $(XREF _variant, _Variant).
* Note: Do not confuse this with $(XREF _variant, _Variant).
*/
enum Variant
{
@ -510,9 +527,8 @@ public struct UUID
* RFC 4122 defines different internal data layouts for UUIDs.
* Returns the format used by this UUID.
*
* Note: Do not confuse this with $(XREF _variant, _Variant). This has nothing
* to do with $(XREF _variant, _Variant). The type of this property is
* $(MYREF3 std.uuid.UUID.Variant, _Variant).
* Note: Do not confuse this with $(XREF _variant, _Variant).
* The type of this property is $(MYREF3 std.uuid.UUID.Variant, _Variant).
*
* See_Also:
* $(MYREF3 UUID.Variant, Variant)