docfile.cpp File Reference

#include <fstream>
#include "docfile.hpp"
#include "../utils/tinyxml2.h"
#include "../utils/tools.hpp"

Include dependency graph for docfile.cpp:

Go to the source code of this file.

Functions
static void	parseHeader (const std::string &sCombinedArticle, DocumentationEntry &docEntry, std::vector< std::string > &keyWords)
	Parse the documentation article header into the DocumentationEntry structure and the list of keywords associated with this article. More...
static int	indentationLevelDiff (const std::string &sText)
	Calculate the indentation level difference from the passed line. More...

Function Documentation

indentationLevelDiff()

static int indentationLevelDiff ( const std::string &  sText )

static

Calculate the indentation level difference from the passed line.

Parameters

sText

const std::string&

Returns

int

Definition at line 146 of file docfile.cpp.

Referenced by DocumentationArticle::format().

parseHeader()

static void parseHeader ( const std::string &  sCombinedArticle, DocumentationEntry &  docEntry, std::vector< std::string > &  keyWords  )

static

Parse the documentation article header into the DocumentationEntry structure and the list of keywords associated with this article.

Parameters

sCombinedArticle	const std::string&
docEntry	DocumentationEntry&
keyWords	std::vector<std::string>&

Returns

void

Definition at line 37 of file docfile.cpp.

References tinyxml2::XMLElement::Attribute(), tinyxml2::XMLDocument::ErrorStr(), tinyxml2::XMLNode::FirstChildElement(), tinyxml2::XMLElement::GetText(), SyntaxError::HLPIDX_ENTRY_IS_MISSING, SyntaxError::invalid_position, tinyxml2::XMLNode::NextSiblingElement(), tinyxml2::XMLDocument::Parse(), DocumentationEntry::sArticleId, DocumentationEntry::sIdxKeys, DocumentationEntry::sTitle, and tinyxml2::XML_SUCCESS.

Referenced by DocumentationArticle::DocumentationArticle().

Here is the call graph for this function: