diff options
| author | Szczepan Zalega <szczepan@nitrokey.com> | 2019-01-24 18:43:19 +0100 |
|---|---|---|
| committer | Szczepan Zalega <szczepan@nitrokey.com> | 2019-01-24 18:43:19 +0100 |
| commit | f7cbdc09858b7d26765e819c89e4289d30877f74 (patch) | |
| tree | d6f9b5046e86501ab5b0ecc3c1ec3688e22a0307 /README.md | |
| parent | 8e4c28de760033dde2469bb69b76a80076d0fc39 (diff) | |
| parent | af8ee6d30ac8ae45cf440c6bc2e03a873e3db584 (diff) | |
| download | libnitrokey-f7cbdc09858b7d26765e819c89e4289d30877f74.tar.gz libnitrokey-f7cbdc09858b7d26765e819c89e4289d30877f74.tar.bz2 | |
Merge branch 'pr_148'
Generate documentation for C API using Doxygen
Fixes #148
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -163,7 +163,7 @@ In case no devices are connected, a friendly message will be printed. All available functions for C and Python are listed in [NK_C_API.h](NK_C_API.h). Please check `Documentation` section below. ## Documentation -The documentation of C API is included in the sources (could be generated with doxygen if requested). +The documentation of C API is included in the sources (can be generated with `make doc` if Doxygen is installed). Please check [NK_C_API.h](NK_C_API.h) (C API) for high level commands and [libnitrokey/NitrokeyManager.h](libnitrokey/NitrokeyManager.h) (C++ API). All devices' commands are listed along with packet format in [libnitrokey/stick10_commands.h](libnitrokey/stick10_commands.h) and [libnitrokey/stick20_commands.h](libnitrokey/stick20_commands.h) respectively for Nitrokey Pro and Nitrokey Storage products. # Tests |