Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update ArgumentParser::parseArgs()/readArgs() documentation

This commit is contained in:
Martchus 2019-09-14 20:53:25 +02:00
parent 7cdfca9407
commit 23b774e374
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
application/argumentparser.cpp
View File

@ -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.
*/