Spicy
Classes | Public Attributes | List of all members
hilti::operator_::Signature Struct Reference

#include <operator.h>

Classes

struct  QParam
 
struct  QResult
 
struct  QType
 

Public Attributes

operator_::Kind kind
 
operator_::Priority priority = operator_::Priority::Normal
 
QType self
 
QType op0
 
QType op1
 
QType op2
 
std::optional< std::string > member
 
QParam param0
 
QParam param1
 
QParam param2
 
QParam param3
 
QParam param4
 
QResult result
 
std::string result_doc
 
std::string ns
 
std::string doc
 
bool skip_doc = false
 

Detailed Description

Helper for defining operator signatures.

Member Data Documentation

◆ doc

std::string hilti::operator_::Signature::doc

documentation string describing the operator

◆ ns

std::string hilti::operator_::Signature::ns

namespace where to document this operator

◆ result

QResult hilti::operator_::Signature::result

result of the method; if not set, result() will be called dynamically

◆ result_doc

std::string hilti::operator_::Signature::result_doc

documentation string for the result

◆ skip_doc

bool hilti::operator_::Signature::skip_doc = false

if true, do not include this operator into any documentation


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