summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2018-11-07 23:59:44 +0100
committerPhilipp Gesang <phg@phi-gamma.net>2018-11-07 23:59:44 +0100
commit5fb6d7cbb60bb5420562b9aa336a796d1bb63a2f (patch)
tree2a6f2036f6be07667ecb810fe9ab8e5b64a95657
parent010d9d9d7f82e6d880da646c810492618476ee32 (diff)
downloadocaml-sid-5fb6d7cbb60bb5420562b9aa336a796d1bb63a2f.tar.gz
sid.mli: add short module blurb
-rw-r--r--sid.mli9
1 files changed, 9 insertions, 0 deletions
diff --git a/sid.mli b/sid.mli
index 9730d14..e2c94df 100644
--- a/sid.mli
+++ b/sid.mli
@@ -1,5 +1,14 @@
(* SPDX-License-Identifier: LGPL-3.0-only WITH OCaml-LGPL-linking-exception *)
+(** Security identifiers.
+
+ {e Sid} implements the “Security Identifier” data type commonly used
+ on the Microsoft Windows platform. When processing input, it tries to
+ adhere as closely to the specification as possible.
+
+ @see <https://msdn.microsoft.com/en-us/library/cc230371.aspx> the relevant
+ section in the {e [MS-DTYP]} compilation of types. *)
+
type t
type sub_auths = Stdint.Uint32.t array