a11::flow::vocabulary::WordDoc Struct Reference

What one word of the language does, as reference an editor can show. More...

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

Public Attributes
std::string_view	summary
	One line: what it does. A sentence, because it is shown as one.
std::string_view	takes
	What it takes, spelled the way a reader writes it rather than as a type name: "a count", "an expression, with `it` bound to the value in hand".
std::string_view	detail
	How it behaves, and the caveat if it has one. Markdown, a short paragraph.
std::string_view	example
	One line of Flow showing it in use.

Detailed Description

What one word of the language does, as reference an editor can show.

Here rather than in each editor for the reason everything else in this file is here: there are four frontends and one language. A hover, the popup beside a completion list, and a11-flow vocabulary are three questions with one answer, and a copy of this in the IntelliJ plugin would be a copy that goes stale the first time a stage learns a new argument.

The text explains semantics rather than merely repeating a token kind and argument category.

Member Data Documentation

detail

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

How it behaves, and the caveat if it has one. Markdown, a short paragraph.

example

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

One line of Flow showing it in use.

Reference without an example is a definition, and a definition is what the reader is trying to get past.

summary

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

One line: what it does. A sentence, because it is shown as one.

takes

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

What it takes, spelled the way a reader writes it rather than as a type name: "a count", "an expression, with `it` bound to the value in hand".

Empty where it takes nothing.

---

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

• cpp/a11/flow/vocabulary.h