HtmlDocExtractor Class

(Utils::HtmlDocExtractor)

Public Types

enum Mode { FirstParagraph, Extended }

Public Functions

HtmlDocExtractor()
void applyFormatting(const bool format)
QString getClassOrNamespaceBrief(const QString &html, const QString &mark) const
QString getClassOrNamespaceDescription(const QString &html, const QString &mark) const
QString getEnumDescription(const QString &html, const QString &mark) const
QString getFunctionDescription(const QString &html, const QString &mark, const bool mainOverload = true) const
QString getMacroDescription(const QString &html, const QString &mark) const
QString getQMakeFunctionId(const QString &html, const QString &mark) const
QString getQMakeVariableOrFunctionDescription(const QString &html, const QString &mark) const
QString getQmlComponentDescription(const QString &html, const QString &mark) const
QString getQmlPropertyDescription(const QString &html, const QString &mark) const
QString getTypedefDescription(const QString &html, const QString &mark) const
void setMode(Mode mode)

Member Type Documentation

enum HtmlDocExtractor::Mode

Member Function Documentation

HtmlDocExtractor::HtmlDocExtractor()

Default constructs an instance of HtmlDocExtractor.

void HtmlDocExtractor::applyFormatting(const bool format)

QString HtmlDocExtractor::getClassOrNamespaceBrief(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getClassOrNamespaceDescription(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getEnumDescription(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getFunctionDescription(const QString &html, const QString &mark, const bool mainOverload = true) const

QString HtmlDocExtractor::getMacroDescription(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getQMakeFunctionId(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getQMakeVariableOrFunctionDescription(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getQmlComponentDescription(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getQmlPropertyDescription(const QString &html, const QString &mark) const

QString HtmlDocExtractor::getTypedefDescription(const QString &html, const QString &mark) const

void HtmlDocExtractor::setMode(Mode mode)