welder::detail::function_doc Struct Reference

The raw documentation pieces of a function, handed to a style to assemble. More...

#include <welder/doc.hpp>

Public Attributes
const char *	summary {nullptr}
	The function's own doc.
std::span< const param_doc >	params {}
	Per-parameter doc, declaration order.
const char *	returns {nullptr}
	The function's returns.

Detailed Description

The raw documentation pieces of a function, handed to a style to assemble.

A struct (rather than a growing argument list) so adding future sections — a Raises:, a Note: — does not re-break the doc_style concept. Any member may be empty/null: a function with only a returns and no summary is valid.

Definition at line 253 of file doc.hpp.

Member Data Documentation

params

std::span<const param_doc> welder::detail::function_doc::params {}

Per-parameter doc, declaration order.

Definition at line 255 of file doc.hpp.

returns

const char* welder::detail::function_doc::returns {nullptr}

The function's returns.

Definition at line 256 of file doc.hpp.

summary

const char* welder::detail::function_doc::summary {nullptr}

The function's own doc.

Definition at line 254 of file doc.hpp.

---

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

• src/welder/doc.hpp