RetroLinker
Linker for several 8-bit, 16-bit and 32-bit formats
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Linker::OptionDescription< void > Class Reference

A typeless option description, used as a base class for documenting typed options, as well as options that do not have a value (memory model specifications) More...

#include <options.h>

Inheritance diagram for Linker::OptionDescription< void >:
Linker::Option< void > Linker::Option< bool > Linker::Option< std::optional< T > > Linker::Option< std::vector< T > >

Public Member Functions

 OptionDescription (std::string name, std::string description)
 
virtual std::string type_name ()
 Returns a textual representation of the type, to be displayed to the user.
 

Public Attributes

std::string name
 The name of a command line option, as provided on the command line.
 
std::string description
 Description printed when -h is issued.
 

Detailed Description

A typeless option description, used as a base class for documenting typed options, as well as options that do not have a value (memory model specifications)

Member Function Documentation

◆ type_name()

virtual std::string Linker::OptionDescription< void >::type_name ( )
inlinevirtual

Returns a textual representation of the type, to be displayed to the user.

This function only returns a meaningful value if the option has a type.

Reimplemented in Linker::Option< bool >, Linker::Option< std::vector< T > >, and Linker::Option< std::optional< T > >.


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