A11 (C++ runtime)
Native C++ implementation of the A11 streaming action runtime
Loading...
Searching...
No Matches
a11::flow::vocabulary::WordDoc Struct Reference

Documentation for a language word, shared by editor and CLI surfaces. More...

#include <cpp/a11/flow/vocabulary.h>

Public Attributes

std::string_view summary
 One-line description shown in a summary.
 
std::string_view takes
 Argument description in source terms, or empty for no argument.
 
std::string_view detail
 Behavior description as a short Markdown paragraph.
 
std::string_view example
 Single-line examples use newlines; multiline examples use blank lines.
 

Detailed Description

Documentation for a language word, shared by editor and CLI surfaces.

Member Data Documentation

◆ detail

std::string_view a11::flow::vocabulary::WordDoc::detail

Behavior description as a short Markdown paragraph.

◆ example

std::string_view a11::flow::vocabulary::WordDoc::example

Single-line examples use newlines; multiline examples use blank lines.

A sentence before a multiline flow introduces its use case.

◆ summary

std::string_view a11::flow::vocabulary::WordDoc::summary

One-line description shown in a summary.

◆ takes

std::string_view a11::flow::vocabulary::WordDoc::takes

Argument description in source terms, or empty for no argument.


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