1 /**
2  * @file bindings/cli/print_help.hpp
3  * @author Ryan Curtin
4  *
5  * Print help for a command-line program.
6  *
7  * mlpack is free software; you may redistribute it and/or modify it under the
8  * terms of the 3-clause BSD license.  You should have received a copy of the
9  * 3-clause BSD license along with mlpack.  If not, see
10  * http://www.opensource.org/licenses/BSD-3-Clause for more information.
11  */
12 #ifndef MLPACK_BINDINGS_CLI_PRINT_HELP_HPP
13 #define MLPACK_BINDINGS_CLI_PRINT_HELP_HPP
14 
15 #include <mlpack/core.hpp>
16 
17 namespace mlpack {
18 namespace bindings {
19 namespace cli {
20 
21 /**
22  * Print the help for the given parameter.  If no parameter is specified, then
23  * help will be printed for all parameters.
24  *
25  * @param param Parameter name to print help for.
26  */
27 void PrintHelp(const std::string& param = "");
28 
29 } // namespace cli
30 } // namespace bindings
31 } // namespace mlpack
32 
33 #endif
34