From 23b774e374ec64dc58623a1e26893ae9ba62cb10 Mon Sep 17 00:00:00 2001 From: Martchus Date: Sat, 14 Sep 2019 20:53:25 +0200 Subject: [PATCH] Update ArgumentParser::parseArgs()/readArgs() documentation --- application/argumentparser.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/application/argumentparser.cpp b/application/argumentparser.cpp index 788d5e1..90fb0e7 100644 --- a/application/argumentparser.cpp +++ b/application/argumentparser.cpp @@ -886,10 +886,10 @@ void ArgumentParser::printHelp(ostream &os) const * - This method will not return in the error case if the ParseArgumentBehavior::ExitOnFailure is present * (default). * - This method will not return in case shell completion is requested. This behavior can be altered - * by overriding CppUtilities::exitFunction which defaults to &std::exit. + * by overriding the exit function via ArgumentParser::setExitFunction() which defaults to &std::exit. * \throws Throws Failure if the specified arguments are invalid and the ParseArgumentBehavior::ExitOnFailure * flag is *not* present. - * \sa parseArgs(), readArgs(), parseArgsOrExit() + * \sa readArgs() */ void ArgumentParser::parseArgs(int argc, const char *const *argv, ParseArgumentBehavior behavior) { @@ -921,9 +921,9 @@ void ArgumentParser::parseArgs(int argc, const char *const *argv, ParseArgumentB * - In contrast to parseArgs() this method does not check whether constraints are violated and it * does not call any callbacks. * - This method will not return in case shell completion is requested. This behavior can be altered - * by overriding CppUtilities::exitFunction which defaults to &std::exit. + * by overriding the exit function via ArgumentParser::setExitFunction() which defaults to &std::exit. * \throws Throws Failure if the specified arguments are invalid. - * \sa parseArgs(), parseArgsOrExit() + * \sa parseArgs() * \deprecated In next major release, this method will be private. parseArgs() can serve the same * purpose then. */