From 079123b5c4c25a453ba4d3c6ffa1b5f9f39c5dad Mon Sep 17 00:00:00 2001
From: Gabriele Contini <contini.mailing@gmail.com>
Date: 周六, 21 3月 2020 20:57:47 +0800
Subject: [PATCH] update docs

---
 src/library/hw_identifier/identification_strategy.hpp |   13 ++++++++-----
 1 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/src/library/hw_identifier/identification_strategy.hpp b/src/library/hw_identifier/identification_strategy.hpp
index 22ded81..1f0d1bc 100644
--- a/src/library/hw_identifier/identification_strategy.hpp
+++ b/src/library/hw_identifier/identification_strategy.hpp
@@ -1,5 +1,5 @@
-/*
- * identification_strategy.hpp
+/**
+ * \file identification_strategy.hpp
  *
  *  Created on: Jan 1, 2020
  *      Author: devel
@@ -18,14 +18,17 @@
 namespace license {
 namespace hw_identifier {
 
+/**
+ * Abstract class that represent a way to calculate hardware identifiers.
+ */
 class IdentificationStrategy {
 protected:
 	IdentificationStrategy(){};
 
 public:
 	virtual ~IdentificationStrategy(){};
-	virtual LCC_API_IDENTIFICATION_STRATEGY identification_strategy() const = 0;
-	virtual FUNCTION_RETURN identify_pc(HwIdentifier& identifier_out) const;
+	virtual LCC_API_HW_IDENTIFICATION_STRATEGY identification_strategy() const = 0;
+	virtual FUNCTION_RETURN generate_pc_id(HwIdentifier& identifier_out) const;
 	virtual std::vector<HwIdentifier> alternative_ids() const = 0;
 	virtual LCC_EVENT_TYPE validate_identifier(const HwIdentifier& identifier_in) const;
 
@@ -34,7 +37,7 @@
 	 * @param strategy
 	 * @return
 	 */
-	static std::unique_ptr<IdentificationStrategy> get_strategy(LCC_API_IDENTIFICATION_STRATEGY strategy);
+	static std::unique_ptr<IdentificationStrategy> get_strategy(LCC_API_HW_IDENTIFICATION_STRATEGY strategy);
 };
 
 }  // namespace hw_identifier

--
Gitblit v1.9.1