Spicy
Public Member Functions | List of all members
hilti::node::WithDocString Class Reference

#include <node.h>

Inheritance diagram for hilti::node::WithDocString:
hilti::DeclarationBase hilti::Module spicy::type::unit::item::Field hilti::declaration::Constant hilti::declaration::Expression hilti::declaration::Field hilti::declaration::Function hilti::declaration::GlobalVariable hilti::declaration::ImportedModule hilti::declaration::LocalVariable hilti::declaration::Module hilti::declaration::Parameter hilti::declaration::Property hilti::declaration::Type spicy::declaration::UnitHook

Public Member Functions

const std::optional< DocString > & documentation () const
 
void clearDocumentation ()
 
void setDocumentation (DocString doc)
 

Detailed Description

Common mix-in class for nodes storing doc strings.

Member Function Documentation

◆ clearDocumentation()

void hilti::node::WithDocString::clearDocumentation ( )
inline

Clears out any documentation associated with the declaration.

◆ documentation()

const std::optional<DocString>& hilti::node::WithDocString::documentation ( ) const
inline

Returns the documentation associated with the declaration, if any.

◆ setDocumentation()

void hilti::node::WithDocString::setDocumentation ( DocString  doc)
inline

Sets the documentation associated with the declaration.


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