Developer documentation
Version 3.0.3-105-gd3941f44
MR::App::Example Class Reference

object for storing a single example command usage More...

#include "app.h"

Public Member Functions

 Example (const std::string &title, const std::string &code, const std::string &description)
 
 operator std::string () const
 
std::string syntax (int format) const
 

Public Attributes

const std::string title
 
const std::string code
 
const std::string description
 

Detailed Description

object for storing a single example command usage

Definition at line 95 of file app.h.

Constructor & Destructor Documentation

◆ Example()

MR::App::Example::Example ( const std::string &  title,
const std::string &  code,
const std::string &  description 
)
inline

Definition at line 97 of file app.h.

Member Function Documentation

◆ operator std::string()

MR::App::Example::operator std::string ( ) const

◆ syntax()

std::string MR::App::Example::syntax ( int  format) const

Member Data Documentation

◆ code

const std::string MR::App::Example::code

Definition at line 103 of file app.h.

◆ description

const std::string MR::App::Example::description

Definition at line 103 of file app.h.

◆ title

const std::string MR::App::Example::title

Definition at line 103 of file app.h.


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