Nickvision::Localization::Documentation Namespace Reference

Functions
std::string	getHelpUrl (const std::string &englishShortName, const std::string &htmlDocStore, const std::string &pageName)
	Gets the url for a documentation page.

Function Documentation

getHelpUrl()

std::string Nickvision::Localization::Documentation::getHelpUrl	(	const std::string &	englishShortName,
		const std::string &	htmlDocStore,
		const std::string &	pageName )

Gets the url for a documentation page.

This will be a yelp url for Linux and a website url for Windows and Linux snaps.

Parameters

englishShortName	The english short name of the application
htmlDocStore	The html docs store url
pageName	The name of the documentation page to get

Returns

The url for the documentation page