From 97ca2423a4686f7f9e85a33a88556dae4aad1bab Mon Sep 17 00:00:00 2001
From: Maximilien Siavelis <m@siav.pw>
Date: 周一, 06 5月 2019 21:47:20 +0800
Subject: [PATCH] Merge pull request #21 from matteovaralta91/master

---
 src/tools/license-generator/license-generator.h |   19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/src/tools/license-generator/license-generator.h b/src/tools/license-generator/license-generator.h
index 7201aef..361f263 100644
--- a/src/tools/license-generator/license-generator.h
+++ b/src/tools/license-generator/license-generator.h
@@ -15,19 +15,30 @@
 
 namespace po = boost::program_options;
 /**
- * This class is used to generate a new license.
- * It has no metnod main, for testing reasons.
+ * This class contains all the logic used to generate a new license.
+ * Since it has no method "main", can be easily used in unit tests.
  */
 class LicenseGenerator {
 private:
 	LicenseGenerator();
 	static void printHelp(const char* prog_name, const po::options_description& options);
 	static po::options_description configureProgramOptions();
-	static vector<FullLicenseInfo> parseLicenseInfo(po::variables_map vm);
+	static vector<FullLicenseInfo> parseLicenseInfo(const po::variables_map& vm);
 	static void generateAndOutputLicenses(const po::variables_map& vm,
 			ostream& outputFile);
-	static string normalize_date(const char * s);
+	static string normalize_date(const std::string& s);
 public:
+	/**
+	 * Available options:
+	 * <ul>
+	 * 	<li>-s : use Client Signature.</li>
+	 * </ul>
+	 * @param argc
+	 * 			count of arguments.
+	 * @param argv
+	 * 			char** of parameters.
+	 * @return
+	 */
 	static int generateLicense(int argc, const char** argv);
 };
 

--
Gitblit v1.9.1