senf::console::factory::SimpleCommand Class Reference

SimpleCommandNode factory. More...

#include <senf/Utils/Console/Node.hh>

Inheritance diagram for senf::console::factory::SimpleCommand:

Public Types

typedef SimpleCommandNode node_type
 
typedef SimpleCommandNoderesult_type
 

Public Member Functions

 SimpleCommand (SimpleCommandNode::Function fn)
 
SimpleCommand const & doc (std::string const &doc) const
 Set simple command documentation. More...
 
SimpleCommand const & shortdoc (std::string const &doc) const
 Set simple command short documentation. More...
 

Detailed Description

SimpleCommandNode factory.

This factory will create a SimpleCommandNode calling the given callback. A SimpleCommandNode does not support overloading or automatic argument parsing.

Attention
This class is of interest mostly for testing and as a simple CommandNode example. Use senf::console::factory::Command instead.

Definition at line 726 of file Node.hh.

Member Typedef Documentation

◆ node_type

◆ result_type

Constructor & Destructor Documentation

◆ SimpleCommand()

senf::console::factory::SimpleCommand::SimpleCommand ( SimpleCommandNode::Function  fn)
explicit

Member Function Documentation

◆ doc()

SimpleCommand const& senf::console::factory::SimpleCommand::doc ( std::string const &  doc) const

Set simple command documentation.

◆ shortdoc()

SimpleCommand const& senf::console::factory::SimpleCommand::shortdoc ( std::string const &  doc) const

Set simple command short documentation.


The documentation for this class was generated from the following file: