[mlpack] 23/35: Update documentation; 'parent' is very outdated; that parameter is actually 'alias'.

[Barak A. Pearlmutter]

This is an automated email from the git hooks/post-receive script.

bap pushed a commit to branch master
in repository mlpack.

commit 6c394ffb083c4be7ca9e8a8f8c61c116fbd222b5
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'.
---
 src/mlpack/core/util/cli_impl.hpp |  9 ++++-----
 src/mlpack/core/util/option.hpp   | 12 +++++-------
 2 files changed, 9 insertions(+), 12 deletions(-)

diff --git a/src/mlpack/core/util/cli_impl.hpp b/src/mlpack/core/util/cli_impl.hpp
index 34ef0a5..34715d8 100644
--- a/src/mlpack/core/util/cli_impl.hpp
+++ b/src/mlpack/core/util/cli_impl.hpp
@@ -28,12 +28,11 @@ 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,
- *   eg bar/foo in bar/foo/buzz.
- * @param required If required, the program will refuse to run
- *   unless the parameter is specified.
+ * @param alias Short name of the parameter.
+ * @param required If required, the program will refuse to run unless the
+ *     parameter is specified.
  */
 template<typename T>
 void CLI::Add(const std::string& identifier,
diff --git a/src/mlpack/core/util/option.hpp b/src/mlpack/core/util/option.hpp
index 0e6384f..7300eba 100644
--- a/src/mlpack/core/util/option.hpp
+++ b/src/mlpack/core/util/option.hpp
@@ -45,15 +45,14 @@ 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.
    */
   Option(bool ignoreTemplate,
          N defaultValue,
          const std::string& identifier,
          const std::string& description,
-         const std::string& parent = std::string(""),
+         const std::string& alias = std::string(""),
          bool required = false);
 
   /**
@@ -63,12 +62,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);
 };
 
 /**
@@ -77,7 +75,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
 {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/mlpack.git