Mr.Docs
Mr.Docs The C++ Alliance
Download

Mr.Docs

    • Getting Started
      • Demo Gallery
      • Installation
      • Basic Usage
      • Migration Notes
    • Commands
      • Overview
      • Block Commands
      • Metadata Commands
      • Inline Commands
      • Reference
    • Configuration
      • Overview
      • Inputs
      • Filters
      • Extraction
      • Output
      • Diagnostics
      • Reference
    • Generators
      • Overview
      • HTML
      • AsciiDoc
      • XML
    • Extensions
      • Extensions
      • Handlebars Extensions
      • Data-Driven Generators
      • Antora Extensions
      • Mr.Docs as a Library
      • DOM Reference
      • Library Reference
    • Contribute
      • Contributor Quickstart
      • Workflow & PR hygiene
      • Testing & fixtures
      • Options & architecture
      • Codebase tour
      • Docs changes
    • Design Notes
    • License
Mr.Docs develop
  • Mr.Docs
    • master
    • develop
    • v0.8.0
    • v0.0.5
    • v0.0.4
    • v0.0.3
    • v0.0.2
    • v0.0.1
  • Mr.Docs
  • Reference
  • mrdocs
  • getOperatorReadableName
master develop v0.8.0 v0.0.5 v0.0.4 v0.0.3 v0.0.2 v0.0.1

mrdocs::getOperatorReadableName

Return the human‐readable name of the operator

Synopsis

Declared in <mrdocs/Metadata/Specifiers/OperatorKind.hpp>

Optional<std::string_view>
getOperatorReadableName(
    OperatorKind kind,
    int nParams);

Return Value

The readable name, or nullopt if the operator is not recognized.

Parameters

Name

Description

kind

The kind of operator.

nParams

The number of parameters the operator takes.

Created with MrDocs