DocumentationArticle Struct Reference

This structure defines a single article in a documentation file. More...

#include <docfile.hpp>

Collaboration diagram for DocumentationArticle:

Public Member Functions
	DocumentationArticle (const std::vector< std::string > &vArticleContents, const std::string &sFileName)
	Create a DocumentationArticle structure from the selected part of the documentation file containing exactly one article. More...
std::string	format ()
	Format the documentation article into a single string, which then can be printed to a file. More...

Public Attributes
DocumentationEntry	m_docEntry
std::vector< std::string >	m_keywords
std::vector< std::string >	m_contents

Detailed Description

This structure defines a single article in a documentation file.

Definition at line 43 of file docfile.hpp.

Constructor & Destructor Documentation

DocumentationArticle()

DocumentationArticle::DocumentationArticle	(	const std::vector< std::string > &	vArticleContents,
		const std::string &	sFileName
	)

Create a DocumentationArticle structure from the selected part of the documentation file containing exactly one article.

Parameters

vArticleContents	const std::vector<std::string>&
sFileName	const std::string&

Definition at line 90 of file docfile.cpp.

References m_contents, m_docEntry, m_keywords, parseHeader(), and DocumentationEntry::sDocFilePath.

Here is the call graph for this function:

Member Function Documentation

format()

std::string DocumentationArticle::format

(

)

Format the documentation article into a single string, which then can be printed to a file.

Returns

std::string

Definition at line 199 of file docfile.cpp.

References indentationLevelDiff(), m_contents, m_docEntry, m_keywords, max, DocumentationEntry::sArticleId, DocumentationEntry::sIdxKeys, and DocumentationEntry::sTitle.

Here is the call graph for this function:

Member Data Documentation

m_contents

std::vector<std::string> DocumentationArticle::m_contents

Definition at line 47 of file docfile.hpp.

Referenced by DocumentationArticle(), and format().

m_docEntry

DocumentationEntry DocumentationArticle::m_docEntry

Definition at line 45 of file docfile.hpp.

Referenced by DocumentationArticle(), and format().

m_keywords

std::vector<std::string> DocumentationArticle::m_keywords

Definition at line 46 of file docfile.hpp.

Referenced by DocumentationArticle(), and format().

---

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

• D:/CPP/numere-source/trunk/kernel/core/documentation/docfile.hpp
• D:/CPP/numere-source/trunk/kernel/core/documentation/docfile.cpp