The compiler detail class for VuoComment
.
Definition at line 19 of file VuoCompilerComment.hh.
Public Member Functions | |
VuoCompilerComment (VuoComment *baseComment) | |
Creates a compiler detail for the specified baseComment . More... | |
string | getGraphvizIdentifierPrefix (void) |
Returns a suggested UpperCamelCase prefix for the comment's Graphviz identifier. More... | |
string | getGraphvizIdentifier (void) |
Gets the identifier that will appear in .vuo (Graphviz dot format) files. More... | |
void | setGraphvizIdentifier (string graphvizIdentifier) |
Sets the identifier that will appear in .vuo (Graphviz dot format) files. More... | |
string | getGraphvizDeclaration (double xPositionOffset=0, double yPositionOffset=0) |
Returns a string containing the declaration for this comment as it would appear in a .vuo (Graphviz dot format) file. More... | |
Public Member Functions inherited from VuoBaseDetail< VuoComment > | |
VuoBaseDetail (string description, VuoComment *base) | |
Creates a detail class. More... | |
VuoComment * | getBase (void) const |
Returns the detail class instance's base class instance. More... | |
void | setBase (VuoComment *base) |
Sets the detail class instance's base class instance. More... | |
VuoCompilerComment::VuoCompilerComment | ( | VuoComment * | baseComment | ) |
Creates a compiler detail for the specified baseComment
.
Definition at line 19 of file VuoCompilerComment.cc.
string VuoCompilerComment::getGraphvizDeclaration | ( | double | xPositionOffset = 0 , |
double | yPositionOffset = 0 |
||
) |
Returns a string containing the declaration for this comment as it would appear in a .vuo (Graphviz dot format) file.
Definition at line 54 of file VuoCompilerComment.cc.
string VuoCompilerComment::getGraphvizIdentifier | ( | void | ) |
Gets the identifier that will appear in .vuo (Graphviz dot format) files.
Definition at line 37 of file VuoCompilerComment.cc.
string VuoCompilerComment::getGraphvizIdentifierPrefix | ( | void | ) |
Returns a suggested UpperCamelCase prefix for the comment's Graphviz identifier.
Definition at line 29 of file VuoCompilerComment.cc.
void VuoCompilerComment::setGraphvizIdentifier | ( | string | graphvizIdentifier | ) |
Sets the identifier that will appear in .vuo (Graphviz dot format) files.
Definition at line 45 of file VuoCompilerComment.cc.