From: Rafał Długołęcki <rafal@dlugolecki.net.pl>
Date: Wed, 6 May 2015 07:01:03 +0000 (+0200)
Subject: Standarize Type in template.
X-Git-Tag: v0.2~12
X-Git-Url: https://git.dlugolecki.net.pl/?p=command.git;a=commitdiff_plain;h=68461ce43951a67646427c05ba94a960dcfa0a55

Standarize Type in template.
---

diff --git a/include/argument.h b/include/argument.h
index 1dae06f..dfaea65 100644
--- a/include/argument.h
+++ b/include/argument.h
@@ -18,10 +18,10 @@ namespace command {
      *  ./myprog /path/to/file
      *  ./myprog "some argument"
      */
-    template<typename ArgumentType>
-    class Argument : public Parameter, public Callable<ArgumentType> {
+    template<typename ParameterType>
+    class Argument : public Parameter, public Callable<ParameterType> {
     protected:
-        ArgumentType value;
+        ParameterType value;
     public:
         typedef class Argument Type;
 
@@ -31,8 +31,8 @@ namespace command {
          * @param description Description of current Argument
          * @param function Function used to handle current Argument.
          */
-        Argument(const std::string & description, void (*function)(ArgumentType))
-            : Parameter(description), Callable<ArgumentType>(function) {
+        Argument(const std::string & description, void (*function)(ParameterType))
+            : Parameter(description), Callable<ParameterType>(function) {
         }
 
         /**
@@ -52,13 +52,13 @@ namespace command {
          * If so current Argument is flagged as used and no more checks against
          * it will be done in future.
          *
-         * \attention If conversion from passed value to ArgumentType is
+         * \attention If conversion from passed value to ParameterType is
          * impossible, it is ignored. It means that it is not understanded by
          * Argument.
          *
          * @param argv command line value against which test will be made.
          *
-         * @return If passed argv is succesfully converted to ArgumentType,
+         * @return If passed argv is succesfully converted to ParameterType,
          *  returns true and Argument is set as used one. If there was an error
          *  during conversion, method returns false and can be used to check
          *  against next value.
diff --git a/include/callable.h b/include/callable.h
index 544b371..4ac1bd9 100644
--- a/include/callable.h
+++ b/include/callable.h
@@ -7,13 +7,13 @@ namespace command {
     /**
      * Callable behaviour class.
      */
-    template<typename ArgumentType>
+    template<typename ParameterType>
     class Callable {
     protected:
         /**
          * Function handling user Arguments
          */
-        void (*func)(ArgumentType);
+        void (*func)(ParameterType);
 
     public:
         /**
@@ -21,7 +21,7 @@ namespace command {
          *
          * @param function Function that will be invoked
          */
-        Callable(void (*function)(ArgumentType))
+        Callable(void (*function)(ParameterType))
             : func(function) {
         }
 
@@ -33,7 +33,7 @@ namespace command {
          *
          * @param value Value passed to program argument
          */
-        void call(ArgumentType value) {
+        void call(ParameterType value) {
             this->func(value);
         }
     };
diff --git a/include/option.h b/include/option.h
index 935914e..963d662 100644
--- a/include/option.h
+++ b/include/option.h
@@ -17,9 +17,9 @@ namespace command {
      *  ./myprog -f=/some/file
      *  ./myprog --level=15
      */
-    template<typename OptionType>
+    template<typename ParameterType>
     class Option
-        : public Parameter, public Callable<OptionType>  {
+        : public Parameter, public Callable<ParameterType>  {
     public:
         typedef std::string OptionName;
     protected:
@@ -31,7 +31,7 @@ namespace command {
         /**
          * Current Option value
          */
-        OptionType value;
+        ParameterType value;
 
     public:
         /**
@@ -41,8 +41,8 @@ namespace command {
          * @param description Description of current Option
          * @param function Function used to handle current Option.
          */
-        Option(const std::string & name, const std::string & description, void (*function)(OptionType))
-            : Parameter(description), Callable<OptionType>(function), name(name) {
+        Option(const std::string & name, const std::string & description, void (*function)(ParameterType))
+            : Parameter(description), Callable<ParameterType>(function), name(name) {
         }
 
         /**
@@ -68,7 +68,7 @@ namespace command {
          * If no equal sign is after OptionName part,
          * std::invalid_argument exception with appropriate message is thrown
          *
-         * If conversion of OptionValue part to OptionType failed,
+         * If conversion of OptionValue part to ParameterType failed,
          * std::invalid_argument exception with appropriate message is thrown
          *
          * @param argv command line value against which test will be made.
@@ -76,13 +76,13 @@ namespace command {
          *
          * @return If passed argv succesfully detected OptionName part as a
          *  current option and its OptionValue part has been succesfully
-         *  converted to OptionType, returns true and Option is set as used one.
+         *  converted to ParameterType, returns true and Option is set as used one.
          *  Otherwise returns false and can be used to check against next value.
          *
          * @throw std::invalid_argument when OptionName part has no equal sign
          *  after itself
          * @throw std::invalid_argument when OptionValue part failed conversion
-         *  to OptionType
+         *  to ParameterType
          */
         virtual bool understand(const std::string & argv)
             throw(std::invalid_argument) {