welder::rods::luacats::enum_writer Struct Reference

An enum handle: the value table text accumulated by add_enumerator, flushed as a ---@enum block by RAII (same rationale as class_writer). More...

#include <welder/rods/lua/luacats/document.hpp>

Public Member Functions
	enum_writer ()=default
	enum_writer (const enum_writer &)=delete
enum_writer &	operator= (const enum_writer &)=delete
	enum_writer (enum_writer &&o) noexcept
enum_writer &	operator= (enum_writer &&o) noexcept
	~enum_writer ()

Public Attributes
document *	doc {nullptr}
std::string *	sink {nullptr}
	Flush target override; null = doc->body (a nested enum flushes into its outer's trailing, like a nested class).
std::string	qualified {}
std::string	enum_doc {}
std::string	values {}
	Accumulated Name = value, lines.

Detailed Description

An enum handle: the value table text accumulated by add_enumerator, flushed as a ---@enum block by RAII (same rationale as class_writer).

Definition at line 397 of file document.hpp.

Constructor & Destructor Documentation

enum_writer() [1/3]

welder::rods::luacats::enum_writer::enum_writer ( )

default

Referenced by enum_writer(), enum_writer(), operator=(), and operator=().

enum_writer() [2/3]

welder::rods::luacats::enum_writer::enum_writer ( const enum_writer & )

delete

References enum_writer().

enum_writer() [3/3]

welder::rods::luacats::enum_writer::enum_writer ( enum_writer && o )

inlinenoexcept

Definition at line 409 of file document.hpp.

References enum_writer().

~enum_writer()

welder::rods::luacats::enum_writer::~enum_writer ( )

inline

Definition at line 419 of file document.hpp.

References doc, welder::rods::luacats::emit_doc_comment(), enum_doc, qualified, sink, and values.

Member Function Documentation

operator=() [1/2]

enum_writer & welder::rods::luacats::enum_writer::operator= ( const enum_writer & )

delete

References enum_writer().

operator=() [2/2]

enum_writer & welder::rods::luacats::enum_writer::operator= ( enum_writer && o )

inlinenoexcept

Definition at line 410 of file document.hpp.

References doc, enum_doc, enum_writer(), qualified, sink, and values.

Member Data Documentation

doc

document* welder::rods::luacats::enum_writer::doc {nullptr}

Definition at line 398 of file document.hpp.

Referenced by welder::rods::luacats::rod::make_enum(), welder::rods::luacats::rod::make_nested_enum(), operator=(), and ~enum_writer().

enum_doc

std::string welder::rods::luacats::enum_writer::enum_doc {}

Definition at line 403 of file document.hpp.

Referenced by welder::rods::luacats::rod::make_enum(), welder::rods::luacats::rod::make_nested_enum(), operator=(), and ~enum_writer().

qualified

std::string welder::rods::luacats::enum_writer::qualified {}

Definition at line 402 of file document.hpp.

Referenced by welder::rods::luacats::rod::make_enum(), welder::rods::luacats::rod::make_nested_enum(), operator=(), and ~enum_writer().

sink

std::string* welder::rods::luacats::enum_writer::sink {nullptr}

Flush target override; null = doc->body (a nested enum flushes into its outer's trailing, like a nested class).

Definition at line 399 of file document.hpp.

Referenced by welder::rods::luacats::rod::make_nested_enum(), operator=(), and ~enum_writer().

values

std::string welder::rods::luacats::enum_writer::values {}

Accumulated Name = value, lines.

Definition at line 404 of file document.hpp.

Referenced by welder::rods::luacats::rod::add_enumerator(), operator=(), and ~enum_writer().

---

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

• src/welder/rods/lua/luacats/document.hpp