gazagnaire.org / ocaml-crypto
upstream: https://github.com/mirage/mirage-crypto
fork atom

fix(lint): add doc comments to test .mli files and missing interfaces

E405: Add doc comments to 14 test module .mli files.
E505: Create common.mli for crypto-pk internal utilities.
E600: Create test_entropy.mli for tests/ directory.

Thomas Gazagnaire dc1f6475 51ee90cc

+39
unified split
+7
pk/common.mli
··· 1 + (** Internal utilities for crypto-pk. *) 2 + 3 + val until : ('a -> bool) -> (unit -> 'a) -> 'a 4 + (** [until p f] repeatedly calls [f ()] until [p] holds on the result. *) 5 + 6 + val guard : bool -> 'a -> (unit, 'a) result 7 + (** [guard p err] is [Ok ()] if [p] is true, [Error err] otherwise. *)
+2
test/pk/test_z_extra.mli
··· 1 + (** Big-integer encoding and generation tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/rng/test_fortuna.mli
··· 1 + (** Fortuna CSPRNG tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/rng/test_hmac_drbg.mli
··· 1 + (** HMAC_DRBG deterministic RNG tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/rng/test_rng.mli
··· 1 + (** RNG interface tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/rng/unix/test_crypto_rng_unix.mli
··· 1 + (** Unix getrandom tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/rng/unix/test_getentropy.mli
··· 1 + (** Getentropy tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/rng/unix/test_urandom.mli
··· 1 + (** Urandom tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/test_ccm.mli
··· 1 + (** AES-CCM authenticated encryption tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/test_chacha20.mli
··· 1 + (** ChaCha20-Poly1305 AEAD tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/test_cipher_block.mli
··· 1 + (** Block cipher tests (AES, DES). *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/test_cipher_stream.mli
··· 1 + (** Stream cipher tests (ARC4). *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/test_native.mli
··· 1 + (** Native acceleration and key parameter tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
test/test_poly1305.mli
··· 1 + (** Poly1305 MAC tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+2
tests/test_crypto_ec.mli
··· 1 + (** Elliptic curve cryptography tests. *) 2 + 1 3 val suite : string * unit Alcotest.test_case list
+4
tests/test_entropy.mli
··· 1 + (** Entropy source tests. *) 2 + 3 + val suite : string * unit Alcotest.test_case list 4 + (** [suite] is the Alcotest test suite for entropy operations. *)