Document boost/uuid/constants.hpp

doc/uuid/constants.adoc

@@ -0,0 +1,28 @@
+[#constants]
+== <boost/uuid/constants.hpp>
+
+:idprefix: constants_
+
+=== Synopsis
+
+[source,c++]
+----
+#include <boost/uuid/namespaces.hpp>
+
+namespace boost {
+namespace uuids {
+
+uuid nil_uuid() noexcept;
+
+}} // namespace boost::uuids
+----
+
+=== Constants
+
+This header provides definitions of some well known UUID constants.
+
+```
+uuid nil_uuid() noexcept;
+```
+
+Returns: :: The nil UUID, `{00000000-0000-0000-0000-000000000000}`.

doc/uuid/reference.adoc

@@ -18,3 +18,4 @@ include::time_generator_v1.adoc[]
 include::time_generator_v6.adoc[]
 include::time_generator_v7.adoc[]
 include::time_generator.adoc[]
+include::constants.adoc[]

doc/uuid/uuid_all.adoc

@@ -12,4 +12,5 @@ This convenience header makes the entire library available.
 #include <boost/uuid/uuid.hpp>
 #include <boost/uuid/uuid_io.hpp>
 #include <boost/uuid/uuid_generators.hpp>
+#include <boost/uuid/constants.hpp>
 ----