From 025c09a83b575871c4efbac3ecf080c472951bdd Mon Sep 17 00:00:00 2001
From: Gabriele Contini <gcontini@users.noreply.github.com>
Date: 周六, 01 2月 2020 00:11:31 +0800
Subject: [PATCH] Deploy documentation to gh-pages branch (#74)
---
include/licensecc/licensecc.h | 29 ++++++++++++++++-------------
1 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/include/licensecc/licensecc.h b/include/licensecc/licensecc.h
index be6f57d..950fe0f 100644
--- a/include/licensecc/licensecc.h
+++ b/include/licensecc/licensecc.h
@@ -1,9 +1,12 @@
+/** \addtogroup api
+ * @{
+ */
#ifndef LICENSEPP_H_
#define LICENSEPP_H_
/*
- * This include file is the public api di License++
-*/
+ * This include file is the public api di Licensecc
+ */
#ifdef __cplusplus
extern "C" {
#endif
@@ -12,17 +15,16 @@
/*
* Method used to convert the LicenseInfo into a human readable
- * representation.
+ * representation. //not yet implemented
*/
-void print_error(char out_buffer[256], LicenseInfo* licenseInfo);
+void print_error(char out_buffer[ERROR_BUFFER_SIZE], LicenseInfo* licenseInfo);
/**
- * This method calculate the pc identifier. The string has to be shown
- * to the user in order to calculate the license.
+ * This method calculates the pc 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.
*/
-void identify_pc(IDENTIFICATION_STRATEGY pc_id_method,
- char chbuffer[PC_IDENTIFIER_SIZE + 1]);
-
+bool identify_pc(IDENTIFICATION_STRATEGY pc_id_method, char* identifier_out, size_t* bufSize);
/**
* This method is used to request the use of one license for a product.
@@ -45,16 +47,17 @@
* Should be called from time to time to confirm we're still using the
* license.
*/
-EVENT_TYPE confirm_license(char * featureName,
- LicenseLocation* licenseLocation);
+EVENT_TYPE confirm_license(char* featureName, LicenseLocation* licenseLocation);
/**
* Do nothing for now, useful for network licenses.
*/
-EVENT_TYPE release_license(char * featureName,
- LicenseLocation licenseLocation);
+EVENT_TYPE release_license(char* featureName, LicenseLocation licenseLocation);
#ifdef __cplusplus
}
#endif
#endif
+/**
+ * @}
+ */
--
Gitblit v1.9.1