gmx::anonymous_namespace{rstparser.cpp} Namespace Reference

Functions
int	countLeadingSpace (const std::string &text, size_t start, size_t end)
	Counts the number of leading spaces in a text range. More...
bool	startsListItem (const std::string &text, size_t index)
	Returns true if a list item starts in text at index. More...
bool	startsTable (const std::string &text, size_t index)
	Returns true if a table starts in text at index. More...
bool	isTitleUnderline (const std::string &text, size_t index)
	Returns true if a line in text starting at index is a title underline. More...

Function Documentation

int gmx::anonymous_namespace{rstparser.cpp}::countLeadingSpace	(	const std::string &	text,
		size_t	start,
		size_t	end
	)

Counts the number of leading spaces in a text range.

Does not throw.

bool gmx::anonymous_namespace{rstparser.cpp}::isTitleUnderline	(	const std::string &	text,
		size_t	index
	)

Returns true if a line in text starting at index is a title underline.

Does not throw.

bool gmx::anonymous_namespace{rstparser.cpp}::startsListItem	(	const std::string &	text,
		size_t	index
	)

Returns true if a list item starts in text at index.

Does not throw.

bool gmx::anonymous_namespace{rstparser.cpp}::startsTable	(	const std::string &	text,
		size_t	index
	)

Returns true if a table starts in text at index.

The function only inspects the first line for something that looks like a reStructuredText table, and accepts also some malformed tables. Any issues should be apparent when Sphinx parses the reStructuredText export, so full validation is not done here.

Does not throw.