Skip to content

Commit

Permalink
Added documentation for extract_filename
Browse files Browse the repository at this point in the history
  • Loading branch information
anutosh491 committed Oct 18, 2024
1 parent 7af0b73 commit 0de46b4
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions include/xeus/xhelper.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ namespace xeus
{
XEUS_API std::string get_start_message(const xconfiguration& config);

/**
* @brief Extracts the filename from the command-line arguments and adjusts argc/argv.
*
* Searches for the "-f" flag in the arguments, extracts the following filename, and
* removes both from the argument list. `argc` is updated to reflect the changes.
* @param argc Reference to the argument count, modified if "-f" is found.
* @param argv Argument list, potentially modified.
* @return The extracted filename, or an empty string if not found.
*/
XEUS_API std::string extract_filename(int &argc, char* argv[]);

XEUS_API bool should_print_version(int argc, char* argv[]);
Expand Down

0 comments on commit 0de46b4

Please sign in to comment.