wizard::DocumentationInterpretter Class Reference

Provides documentation using the URL formats: More...

#include <DocumentationInterpretter.hpp>

Public Member Functions
virtual	~DocumentationInterpretter ()=default

Static Public Member Functions
static bool	FindDocumentation (GrammarDocumentation &aDocumentationData, ParseResults &aResults, const UtTextDocumentRange &aRange, std::string &aPageName, std::string &aSection)
static QString	LookupDocumentationUrl (const QUrl &aUrl, bool &aReturnsURL, QString &aDocumentName)

Detailed Description

Provides documentation using the URL formats:

Constructor & Destructor Documentation

~DocumentationInterpretter()

virtual wizard::DocumentationInterpretter::~DocumentationInterpretter ( )

virtualdefault

Member Function Documentation

FindDocumentation()

bool wizard::DocumentationInterpretter::FindDocumentation ( GrammarDocumentation & aDocumentationData, ParseResults & aResults, const UtTextDocumentRange & aRange, std::string & aPageName, std::string & aSection )

static

References wizard::WsfScriptLookup::AddMethodSymbols(), wizard::WsfScriptLookup::AddSymbolsFromBuiltins(), wizard::WsfScriptLookup::AddSymbolsFromThis(), WsfParseNode::cSCRIPT_MASK, wizard::GrammarDocumentation::FindDocumentation(), wizard::ParseResults::FindLastParseNode(), wizard::WsfScriptData::FindScriptMethodDocumentation(), wizard::WsfScriptData::FindScriptTypeDocumentation(), wizard::WsfScriptLookup::FindType(), WsfParseNode::GetFlags(), wizard::WsfScriptLookup::IdentifierRange(), UsValRef::mFunctionNamePtr, UsValRef::mFunctionTypePtr, wizard::ParseResultsTiny::mProjectPtr, wizard::ParseResultsTiny::mScriptDataPtr, wizard::WsfScriptLookup::SetLocation(), and wizard::WsfScriptLookup::Update().

Referenced by LookupDocumentationUrl().

LookupDocumentationUrl()

QString wizard::DocumentationInterpretter::LookupDocumentationUrl ( const QUrl & aUrl, bool & aReturnsURL, QString & aDocumentName )

static

References wizard::RunEnvManager::DocumentationURL(), FindDocumentation(), wizard::ProjectWorkspace::FindSource(), wizard::Project::GetExe(), wizard::WsfExe::GetGrammarDocumentation(), wizard::Project::GetWorkspace(), LookupDocumentationUrl(), wizard::CommandDocumentation::PeekDocumentationText(), and wizard::Project::WaitForParseResults().

Referenced by LookupDocumentationUrl(), wizard::Environment::OpenUrl(), and wizard::BrowserWidget::SetAddress().

---

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

• DocumentationInterpretter.hpp
• DocumentationInterpretter.cpp