Added mechanism to understand passed Option without value.

[command.git] / include / argument.h

diff --git a/include/argument.h b/include/argument.h
index 159f5eb3f258e284d45768dc657b0f54bcc9b299..53dea343344e8b3b1bf42ab301551135eb9d33c0 100644 (file)
--- a/include/argument.h
+++ b/include/argument.h
@@ -16,6 +16,8 @@ namespace command {
      *
      * Example:
      *  ./myprog ARGUMENT
+     *  ./myprog /path/to/file
+     *  ./myprog "some argument"
      */
     template<typename ArgumentType>
     class Argument : public Parameter, public Callable<ArgumentType> {
@@ -51,16 +53,17 @@ namespace command {
 
         /**
          * Method used for checking if Argument understands user value.
-         * If so current Argument is flagged as used, and no more checks against
+         * If so current Argument is flagged as used and no more checks against
          * it will be done in future.
          *
-         * If conversion from passed value to ArgumentType is impossible, it is
-         * ignored.
+         * \attention If conversion from passed value to ArgumentType 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,
-         *  returns true, and Argument is set as used one. If there was an error
+         *  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.
          */