From ae9cc0f8f418111c04989d1bf28f2cbec7abf847 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 14 3月 2020 23:40:30 +0800
Subject: [PATCH] docs with sphinx
---
include/licensecc/licensecc.h | 8 +++++++-
1 files changed, 7 insertions(+), 1 deletions(-)
diff --git a/include/licensecc/licensecc.h b/include/licensecc/licensecc.h
index 9488e75..0b0391c 100644
--- a/include/licensecc/licensecc.h
+++ b/include/licensecc/licensecc.h
@@ -1,3 +1,6 @@
+/** \addtogroup api
+ * @{
+ */
#ifndef LICENSEPP_H_
#define LICENSEPP_H_
@@ -19,7 +22,7 @@
void print_error(char out_buffer[LCC_API_ERROR_BUFFER_SIZE], LicenseInfo* licenseInfo);
/**
- * This method calculates the pc identifier. The string need to be shown to the user and given back to the software
+ * This method calculates the hardware identifier. The string need to be shown to the user and given back to the software
* editor when issuing a license.
* pc_id_method = STRATEGY_DEFAULT usually works.
*/
@@ -57,3 +60,6 @@
#endif
#endif
+/**
+ * @}
+ */
--
Gitblit v1.9.1