What is at one offset, described. More...

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

Public Attributes
bool	found = false
	Whether anything is there at all.

std::string	text
	The word or construct itself, as written.

SymbolClass	kind = SymbolClass::kExternal

std::string	summary
	One line: what it is. `an action`, ‘a port of 'search’`.

std::string	detail
	Everything else worth reading: an action's description and its ports, a shape's fields, what a stage takes.

std::string	markdown
	The same as Markdown, which is what an editor's hover wants.

Range	range
	What the word covers, so an editor can underline exactly it.

bool	has_definition = false
	Where it was declared, when it was declared in this document.

Range	definition

std::optional< catalogue::Origin >	origin
	Where it was declared, when it was declared in another file and something read that file: an action or a type the catalogue carries an origin for.

Detailed Description

What is at one offset, described.

Member Data Documentation

◆ definition

Range a11::flow::Description::definition

◆ detail

std::string a11::flow::Description::detail

Everything else worth reading: an action's description and its ports, a shape's fields, what a stage takes.

◆ found

bool a11::flow::Description::found = false

Whether anything is there at all.

A caret in whitespace describes nothing, and saying so is not a failure.

◆ has_definition

bool a11::flow::Description::has_definition = false

Where it was declared, when it was declared in this document.

◆ kind

SymbolClass a11::flow::Description::kind = SymbolClass::kExternal

◆ markdown

std::string a11::flow::Description::markdown

The same as Markdown, which is what an editor's hover wants.

◆ origin

std::optional<catalogue::Origin> a11::flow::Description::origin

Where it was declared, when it was declared in another file and something read that file: an action or a type the catalogue carries an origin for.

Separate from [definition], which always refers to the current document.

◆ range

Range a11::flow::Description::range

What the word covers, so an editor can underline exactly it.

◆ summary

std::string a11::flow::Description::summary

One line: what it is. an action, ‘a port of 'search’`.

◆ text

std::string a11::flow::Description::text

The word or construct itself, as written.

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

cpp/a11/flow/navigate.h

Public Attributes