welder::rods::luacats::func_overload Struct Reference

One overload of a callee, pre-rendered into the pieces a group needs: the summary doc, the ---@param block, the ---@return line, the function argument list, and the fun(…) signature for a ---@overload line. More...

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

Public Attributes
std::string	doc {}
	Summary docstring (may be empty).
std::string	params {}
	---@param … lines (may be empty).
std::string	ret_line {}
	The ---@return … line (empty when void).
std::string	args {}
	The function callee(<args>) name list.
std::string	fun_sig {}
	The fun(a: T, …): R signature.

Detailed Description

One overload of a callee, pre-rendered into the pieces a group needs: the summary doc, the ---@param block, the ---@return line, the function argument list, and the fun(…) signature for a ---@overload line.

Definition at line 132 of file document.hpp.

Member Data Documentation

args

std::string welder::rods::luacats::func_overload::args {}

The function callee(<args>) name list.

Definition at line 136 of file document.hpp.

Referenced by welder::rods::luacats::rod::add_constructors(), welder::rods::luacats::build_overload(), and welder::rods::luacats::render_overload_group().

doc

std::string welder::rods::luacats::func_overload::doc {}

Summary docstring (may be empty).

Definition at line 133 of file document.hpp.

Referenced by welder::rods::luacats::build_overload(), and welder::rods::luacats::render_overload_group().

fun_sig

std::string welder::rods::luacats::func_overload::fun_sig {}

The fun(a: T, …): R signature.

Definition at line 137 of file document.hpp.

Referenced by welder::rods::luacats::rod::add_constructors(), and welder::rods::luacats::build_overload().

params

std::string welder::rods::luacats::func_overload::params {}

---@param … lines (may be empty).

Definition at line 134 of file document.hpp.

Referenced by welder::rods::luacats::rod::add_constructors(), welder::rods::luacats::build_overload(), and welder::rods::luacats::render_overload_group().

ret_line

std::string welder::rods::luacats::func_overload::ret_line {}

The ---@return … line (empty when void).

Definition at line 135 of file document.hpp.

Referenced by welder::rods::luacats::rod::add_constructors(), welder::rods::luacats::build_overload(), and welder::rods::luacats::render_overload_group().

---

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

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