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
---
include/licensecc/licensecc.h | 21 +++++++++++----------
1 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/include/licensecc/licensecc.h b/include/licensecc/licensecc.h
index dc273bd..5632788 100644
--- a/include/licensecc/licensecc.h
+++ b/include/licensecc/licensecc.h
@@ -11,8 +11,6 @@
extern "C" {
#endif
-#include <licensecc_properties.h>
-
#include "datatypes.h"
/**
@@ -24,7 +22,7 @@
/**
* \brief Calculates the hardware identifier associated with a specific pc.
* \details
- * The software, when it doesn't find a valid license should show to the user the calculated identifier.
+ * The caller, when it doesn't find a valid license (see `acquire_license` below) should show to the user the calculated identifier.
* The user should report the pc_identifier to the software editor that will in turn use it to issue a license.
*
* pc_id_method = ::STRATEGY_DEFAULT is usually the best choice.
@@ -38,19 +36,22 @@
* @param hw_id_method[in] specifies a preferred identification method. Usually #STRATEGY_DEFAULT works well. See the
* wiki for more informations.
* @param identifier_out[out] buffer where the identification string will be placed.
- * @param identifier_out[in-out] size of the buffer where the identification string will be placed.
+ * @param buf_size[in-out] size of the buffer where the identification string will be placed.
+ * @param execution_environment_info[out] if not null will contain the informations about the execution environment.
*/
-bool identify_pc(LCC_API_HW_IDENTIFICATION_STRATEGY hw_id_method, char* identifier_out, size_t* buf_size);
+bool identify_pc(LCC_API_HW_IDENTIFICATION_STRATEGY hw_id_method, char* identifier_out, size_t* buf_size,
+ ExecutionEnvironmentInfo* execution_environment_info);
/**
* This method is used to request the use of one license for a product.
* In case of local license it's used to check if the product is licensed.
*
- * @return ::LICENSE_OK(0) if successful. Other values if there are errors.
- *
- * @param callerInformation[in]
- * a vendor defined string containing the name of the product we want to request.
- * @param licenseLocation[in] otpional, can be NULL.
+ * @return LCC_EVENT_TYPE::LICENSE_OK(0) if successful. Other values if there are errors.
+ *
+ * @param callerInformation[in] optional, can be NULL.
+ * contains informations on the software that is requesting the license verification. Let the software
+ * specify its version or request verification for features that need to be enabled separately.
+ * @param licenseLocation[in] optional, can be NULL.
* licenseLocation, either the name of the file
* or the name of the environment variable should be !='\0'
* @param license_out[out] optional, can be NULL, if set it will return extra informations about the license.
--
Gitblit v1.9.1