Skip to content

Commit

Permalink
Make comments around the top level command a little more consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
gknowles committed May 5, 2024
1 parent e1786c8 commit 4c474c4
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions libs/dimcli/cli.h
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,9 @@ class DIMCLI_LIB_DECL Cli {

//-----------------------------------------------------------------------
// CONFIGURATION
//
// Descriptions, new options, and other changes are applied to (or created
// within) the selected command and group.

// The 'names' parameter is a whitespace seperated list of option and
// operand names, names take one of four forms and may have prefix/suffix
Expand Down Expand Up @@ -316,8 +319,8 @@ class DIMCLI_LIB_DECL Cli {
// always added to a group, either the default group of the cli (or of the
// selected command), or an explicitly created one.

// Changes config context to point at the selected option group of the
// current command, that you can then start stuffing things into.
// Changes the selected option group of the current command, that you can
// then start stuffing things into.
Cli & group(const std::string & name) &;
Cli && group(const std::string & name) &&;

Expand All @@ -335,10 +338,10 @@ class DIMCLI_LIB_DECL Cli {
const std::string & sortKey() const;

//-----------------------------------------------------------------------
// Changes config context to reference an option group of the selected
// command. Use an empty string to specify the top level context. If a new
// Changes the selected command and option group being configured. Use an
// empty string to specify the top level (no command) context. If a new
// command is selected it is created in the command group of the current
// context.
// command.
Cli & command(const std::string & name, const std::string & group = {}) &;
Cli && command(
const std::string & name,
Expand Down

0 comments on commit 4c474c4

Please sign in to comment.