hilti::DocString Class Reference

#include <doc-string.h>

Public Member Functions
const auto &	summary () const
const auto &	text () const
void	addSummary (const std::string &line)
void	addText (const std::string &line)
void	print (std::ostream &out) const
void	print (hilti::printer::Stream &out) const
std::string	dump () const
	operator bool () const

Detailed Description

Represents an AST node's documentation string.

Member Function Documentation

addSummary()

void hilti::DocString::addSummary ( const std::string &  line )

inline

Appends a line of summary text to the documentation.

Parameters

line	line to add, with optional comment prefix (which will be removed)

addText()

void hilti::DocString::addText ( const std::string &  line )

inline

Appends a line of documentation text to the documentation.

Parameters

line	line to add, with optional comment prefix (which will be removed)

dump()

std::string DocString::dump

(

)

const

Returns a string representation of the full documentation string.

operator bool()

hilti::DocString::operator bool ( ) const

inlineexplicit

Returns true if any summary or documentation text has been added.

print() [1/2]

void DocString::print

(

hilti::printer::Stream &

out

)

const

Renders the comment back into a code representation through our code printer.

print() [2/2]

void DocString::print

(

std::ostream &

out

)

const

Renders the comment back into a multi-line string. This is primarily for debugging.

summary()

const auto& hilti::DocString::summary ( ) const

inline

Returns all lines of summary text added so far. The returned lines will have their comment prefixes stripped.

text()

const auto& hilti::DocString::text ( ) const

inline

Returns all lines of documentation text added so far. The returned lines will have their comment prefixes stripped.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/toolchain/include/ast/doc-string.h
• /home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/toolchain/src/ast/doc-string.cc