diff options
| author | Robin Krahl <me@robin-krahl.de> | 2019-01-16 19:46:59 +0100 |
|---|---|---|
| committer | Robin Krahl <me@robin-krahl.de> | 2019-01-16 19:46:59 +0100 |
| commit | af8ee6d30ac8ae45cf440c6bc2e03a873e3db584 (patch) | |
| tree | 092e9ba31a83076acef3973cd4916b30f2e50412 | |
| parent | 2491bcac250ea7036a4f39b06f4c8dcefea1650b (diff) | |
| download | libnitrokey-feature/doxygen.tar.gz libnitrokey-feature/doxygen.tar.bz2 | |
Update readme for `make doc`feature/doxygen
| -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 [include/NitrokeyManager.h](include/NitrokeyManager.h) (C++ API). All devices' commands are listed along with packet format in [include/stick10_commands.h](include/stick10_commands.h) and [include/stick20_commands.h](include/stick20_commands.h) respectively for Nitrokey Pro and Nitrokey Storage products. # Tests |