]> git.codecow.com Git - Monocypher.git/commit
Better doc integration
authorLoup Vaillant <loup@loup-vaillant.fr>
Fri, 10 Feb 2023 15:56:12 +0000 (16:56 +0100)
committerLoup Vaillant <loup@loup-vaillant.fr>
Fri, 10 Feb 2023 15:56:12 +0000 (16:56 +0100)
commit7e40ae40880a8c239a4b251f80cc6c6cc4589313
tree6095f44a8f8007f90dd8a578606805d98b29f5b2
parent6a224ff69471b7dffd61c9b735b98bf2ebefb975
Better doc integration

Now some checks must pass before we generate the docs:

- .Nm and .Fo names are identical.
- All .Fn names are referenced in .Nm and .Fo.
- All functions from the headers have an .Nm reference.
- No .Nm reference documents a non-existent function.
- No .Xr reference is dead.

In practice this allowed me to catch many stale references very easily.
Since those were basicaly mechanically caugth typos, I did not update
the date nor copyright information in the affected documents.

Closes #250
18 files changed:
dist.sh
doc/crypto_aead_lock.3monocypher
doc/crypto_argon2.3monocypher
doc/crypto_blake2b.3monocypher
doc/crypto_chacha20_djb.3monocypher
doc/crypto_ed25519_sign.3monocypher
doc/crypto_eddsa_sign.3monocypher
doc/crypto_elligator_map.3monocypher
doc/crypto_poly1305.3monocypher
doc/crypto_sha512.3monocypher
doc/crypto_verify16.3monocypher
doc/crypto_wipe.3monocypher
doc/crypto_x25519.3monocypher
doc/doc_check.py [new file with mode: 0755]
doc/doc_extract_examples.sh [moved from doc/extract_examples.sh with 100% similarity]
doc/doc_gen.sh [moved from doc/gen_doc.sh with 91% similarity]
doc/intro.3monocypher
src/optional/monocypher-ed25519.h