wizard::CommandDocumentation Class Reference

#include <CommandDocumentation.hpp>

Static Public Member Functions
static QUrl	GetDocUrl (const UtTextDocumentRange &aRange)
static QString	PeekDocumentationText (GrammarDocumentation &aDocumentationData, WsfParseNode *aLastParseNode)
static QString	PeekDocumentationText (GrammarDocumentation &aDocumentationData, const std::string &aPageName, const std::string &aAnchor)
static QString	FindDocumentationUrl (GrammarDocumentation &aDocumentationData, WsfParseNode *aLastParseNode)
static std::string	PageURL (GrammarDocumentation &aDocumentationData, const std::string &aLinkPath, const std::string &aAnchor)

Member Function Documentation

FindDocumentationUrl()

QString wizard::CommandDocumentation::FindDocumentationUrl ( GrammarDocumentation & aDocumentationData, WsfParseNode * aLastParseNode )

static

References wizard::GrammarDocumentation::FindDocumentation(), and PageURL().

GetDocUrl()

QUrl wizard::CommandDocumentation::GetDocUrl ( const UtTextDocumentRange & aRange )

static

PageURL()

std::string wizard::CommandDocumentation::PageURL ( GrammarDocumentation & aDocumentationData, const std::string & aLinkPath, const std::string & aAnchor )

static

References wizard::GrammarDocumentation::mDocumentationDir.

Referenced by FindDocumentationUrl().

PeekDocumentationText() [1/2]

QString wizard::CommandDocumentation::PeekDocumentationText ( GrammarDocumentation & aDocumentationData, const std::string & aPageName, const std::string & aAnchor )

static

References wizard::GrammarDocumentation::mDocumentationDir, and pos.

PeekDocumentationText() [2/2]

QString wizard::CommandDocumentation::PeekDocumentationText ( GrammarDocumentation & aDocumentationData, WsfParseNode * aLastParseNode )

static

References wizard::GrammarDocumentation::FindDocumentation(), and PeekDocumentationText().

Referenced by wizard::WsfScriptData::FindScriptMethodDocumentation(), wizard::DocumentationInterpretter::LookupDocumentationUrl(), PeekDocumentationText(), and wizard::WsfScriptData::PeekScriptDocumentation().

---

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

• CommandDocumentation.hpp
• CommandDocumentation.cpp