documentation.hpp File Reference

#include <string>
#include "../settings.hpp"

Include dependency graph for documentation.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	doc_Help (const std::string &, Settings &)
	This function shows the content of a documentation article based upon the passed topic. The content is displayed in terminal or in an external window (depending on the settings) or directly written to an HTML file (depending on an additional parameter). More...
std::string	doc_HelpAsHTML (const std::string &, bool, Settings &_option)
	This function returns the documentation article for the selected topic as an HTML std::string. This std::string either may be used to create a corresponding file or it may be displayed in the documentation viewer. More...
void	doc_SearchFct (const std::string &sToLookFor, Settings &_option)
	This function provides the logic for searching for entries in the keywords database. More...

Variables
const std::string	sVersion

Function Documentation

doc_Help()

void doc_Help	(	const std::string &	__sTopic,
		Settings &	_option
	)

This function shows the content of a documentation article based upon the passed topic. The content is displayed in terminal or in an external window (depending on the settings) or directly written to an HTML file (depending on an additional parameter).

Parameters

__sTopic	const std::string&
_option	Settings&

Returns

void

Definition at line 302 of file documentation.cpp.

References _lang, SyntaxError::CANNOT_GENERATE_FILE, FileSystem::declareFileType(), doc_HelpAsHTML(), eraseToken(), findParameter(), Language::get(), Documentation::getHelpArticle(), Documentation::getHelpArticleID(), Documentation::getHelpArticleTitle(), Documentation::getHelpIdxKey(), SyntaxError::invalid_position, LineBreak(), make_hline(), NumeReKernel::print(), NumeReKernel::setDocumentation(), StripSpaces(), toLowerCase(), and FileSystem::ValidizeAndPrepareName().

Referenced by cmd_datagrid(), cmd_define(), cmd_diff(), cmd_edit(), cmd_eval(), cmd_extrema(), cmd_find(), cmd_fit(), cmd_get(), cmd_help(), cmd_ifndefined(), cmd_load(), cmd_new(), cmd_odesolve(), cmd_plotting(), cmd_pulse(), cmd_read(), cmd_redefine(), cmd_set(), cmd_spline(), cmd_stfa(), cmd_taylor(), cmd_undefine(), cmd_warn(), cmd_window(), cmd_write(), and cmd_zeroes().

Here is the call graph for this function:

doc_HelpAsHTML()

std::string doc_HelpAsHTML	(	const std::string &	__sTopic,
		bool	generateFile,
		Settings &	_option
	)

This function returns the documentation article for the selected topic as an HTML std::string. This std::string either may be used to create a corresponding file or it may be displayed in the documentation viewer.

Parameters

__sTopic	const std::string&
generateFile	bool
_option	Settings&

Returns

std::string

Definition at line 932 of file documentation.cpp.

References _lang, doc_ReplaceExprContentForHTML(), doc_ReplaceTokensForHTML(), FILE_CODEBLOCK_END, FILE_CODEBLOCK_START, formatCodeBlock(), Language::get(), Documentation::getArgAtPos(), Documentation::getHelpArticle(), getHighlightedCode(), StripSpaces(), toUpperCase(), VIEWER_CODEBLOCK_END, and VIEWER_CODEBLOCK_START.

Referenced by doc_Help(), and NumeReKernel::getDocumentation().

Here is the call graph for this function:

doc_SearchFct()

void doc_SearchFct	(	const std::string &	sToLookFor,
		Settings &	_option
	)

This function provides the logic for searching for entries in the keywords database.

Parameters

sToLookFor	const std::string&
_option	Settings&

Returns

void

Definition at line 1352 of file documentation.cpp.

References _lang, NumeRe::DataBase::addData(), fileExists(), NumeRe::DataBase::findRecordsUsingRelevance(), Language::get(), NumeRe::DataBase::getElement(), Settings::getExePath(), intCast(), make_hline(), NumeReKernel::print(), NumeReKernel::printPreFmt(), replacePathSeparator(), NumeRe::DataBase::size(), sVersion, NumeReKernel::toggleTableStatus(), toString(), toSystemCodePage(), toUpperCase(), Settings::useCustomLangFiles(), and FileSystem::ValidFileName().

Referenced by cmd_find().

Here is the call graph for this function:

Variable Documentation

sVersion

const std::string sVersion

extern

Definition at line 123 of file NumeReWindow.cpp.