RigDef::DocComment Struct Reference

Description

< Represents a comment (line starting with ';' or '//') that can be anywhere in the file.

Definition at line 311 of file RigDef_File.h.

Data Fields
std::string	comment_text
RigDef::Keyword	commented_keyword = RigDef::Keyword::INVALID
int	commented_datapos = -1

Field Documentation

comment_text

std::string RigDef::DocComment::comment_text

May contain multiple lines separated by '
' - MUST contain leading ';' or '//' at each line!

Definition at line 313 of file RigDef_File.h.

commented_datapos

int RigDef::DocComment::commented_datapos = -1

Position in the data vector for the given keyword.

Definition at line 316 of file RigDef_File.h.

commented_keyword

RigDef::Keyword RigDef::DocComment::commented_keyword = RigDef::Keyword::INVALID

Definition at line 315 of file RigDef_File.h.

---

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

• source/main/resources/rig_def_fileformat/RigDef_File.h