[mlpack-git] master: Update documentation; 'parent' is very outdated; that parameter is actually 'alias'. (7a34fe3)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/59bc0b32630a3ad786706993f4d5e8b087f1c702...0d9a0e263a32b99d8dcf5d2723b3b92c67e669fc

>---------------------------------------------------------------

commit 7a34fe308372263ac661b8c159647ff77013d612
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon Jul 18 11:05:31 2016 -0400

    Update documentation; 'parent' is very outdated; that parameter is actually
    'alias'.


>---------------------------------------------------------------

7a34fe308372263ac661b8c159647ff77013d612
 src/mlpack/core/util/cli_impl.hpp |  5 ++---
 src/mlpack/core/util/option.hpp   | 12 +++++-------
 2 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/src/mlpack/core/util/cli_impl.hpp b/src/mlpack/core/util/cli_impl.hpp
index bc5b366..12db93e 100644
--- a/src/mlpack/core/util/cli_impl.hpp
+++ b/src/mlpack/core/util/cli_impl.hpp
@@ -21,10 +21,9 @@ namespace mlpack {
  *     CheckValue.
  *
  * @tparam T The type of the parameter.
- * @param identifier The name of the parameter, eg foo in bar/foo.
+ * @param identifier The name of the parameter, eg foo.
  * @param description A string description of the parameter.
- * @param parent The name of the parent of the parameter, e.g. bar/foo in
- *     bar/foo/buzz.
+ * @param alias Short name of the parameter.
  * @param required If required, the program will refuse to run unless the
  *     parameter is specified.
  * @param input If true, the parameter is an input parameter (not an output
diff --git a/src/mlpack/core/util/option.hpp b/src/mlpack/core/util/option.hpp
index 1efef14..9f04cfd 100644
--- a/src/mlpack/core/util/option.hpp
+++ b/src/mlpack/core/util/option.hpp
@@ -38,8 +38,7 @@ class Option
    * @param identifier The name of the option (no dashes in front; for --help,
    *      we would pass "help").
    * @param description A short string describing the option.
-   * @param parent Full pathname of the parent module that "owns" this option.
-   *      The default is the root node (an empty string).
+   * @param alias Short name of the parameter.
    * @param required Whether or not the option is required at runtime.
    * @param input Whether or not the option is an input option.
    */
@@ -47,7 +46,7 @@ class Option
          const N defaultValue,
          const std::string& identifier,
          const std::string& description,
-         const std::string& parent = std::string(""),
+         const std::string& alias,
          const bool required = false,
          const bool input = true);
 
@@ -58,12 +57,11 @@ class Option
    * @param identifier The name of the option (no dashes in front); for --help
    *     we would pass "help".
    * @param description A short string describing the option.
-   * @param parent Full pathname of the parent module that "owns" this option.
-   *     The default is the root node (an empty string).
+   * @param alias Short name of the parameter.
    */
   Option(const std::string& identifier,
          const std::string& description,
-         const std::string& parent = std::string(""));
+         const std::string& alias);
 };
 
 /**
@@ -72,7 +70,7 @@ class Option
  * the PROGRAM_INFO() macro to declare these objects.  Only one ProgramDoc
  * object should ever exist.
  *
- * @see core/io/cli.hpp, mlpack::CLI
+ * @see core/util/cli.hpp, mlpack::CLI
  */
 class ProgramDoc
 {