From 55a8483884c70b03c86a6508469f708e48211638 Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周六, 28 11月 2020 09:38:30 +0800 Subject: [PATCH] improve documentation add project/feature documentation --- doc/api/public_api.rst | 33 ++++++++++++++++++++++++++++----- 1 files changed, 28 insertions(+), 5 deletions(-) diff --git a/doc/api/public_api.rst b/doc/api/public_api.rst index 051e84f..df87cb7 100644 --- a/doc/api/public_api.rst +++ b/doc/api/public_api.rst @@ -1,8 +1,31 @@ +####################################### +Public api +####################################### + +The public api of the library can be found in ``include/licensecc/licensecc.h`` that is the only file you should +include when you want to use the library. + +Print hardware identifier +************************** + +.. doxygenfunction:: identify_pc + +.. doxygenenum:: LCC_API_HW_IDENTIFICATION_STRATEGY + +.. doxygengroup:: strategies + :content-only: +Verify a license +*********************** -Documentation -================== -.. doxygennamespace:: license - :project: licensecc - :members: \ No newline at end of file +.. doxygenfunction:: acquire_license + +.. doxygenstruct:: CallerInformations + :members: + +.. doxygenstruct:: LicenseLocation + :members: + +.. doxygenstruct:: LicenseInfo + :members: \ No newline at end of file -- Gitblit v1.9.1