Mr.Docs The C++ Alliance GitHub Repo
  • Mr.Docs
  • Reference
  • mrdocs
  • getOperatorReadableName
master develop 2026.9.29 2026.9.4 v0.8.0
Mr.Docs The C++ Alliance GitHub Repo

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
      • JSON
      • XML
      • No-op
      • Reference
    • Extensions
      • Overview
      • Handlebars Extensions
      • Data-Driven Generators
      • Corpus Transforms
      • Script Generators
      • Antora Extensions
      • Mr.Docs as a Library
      • Script Engines
      • Library Reference
    • Contribute
      • Contributor Quickstart
      • Workflow & PR hygiene
      • Testing & fixtures
      • Options & architecture
      • Codebase tour
      • Docs changes

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