Node representing a parameter list. More...
#include <src/docnode.h>
Public Member Functions | |
DocParamList (DocParser *parser, DocNodeVariant *parent, DocParamSect::Type t, DocParamSect::Direction d) | |
const DocNodeList & | parameters () const |
const DocNodeList & | paramTypes () const |
const DocNodeList & | paragraphs () const |
DocParamSect::Type | type () const |
DocParamSect::Direction | direction () const |
void | markFirst (bool b=TRUE) |
void | markLast (bool b=TRUE) |
bool | isFirst () const |
bool | isLast () const |
Token | parse (const QCString &cmdName) |
Token | parseXml (const QCString ¶mName) |
Public Member Functions inherited from DocNode | |
DocNode (DocParser *parser, DocNodeVariant *parent) | |
~DocNode ()=default | |
DocNodeVariant * | parent () |
const DocNodeVariant * | parent () const |
DocNodeVariant * | thisVariant () |
const DocNodeVariant * | thisVariant () const |
void | setThisVariant (DocNodeVariant *thisVariant) |
DocParser * | parser () |
const DocParser * | parser () const |
void | setParent (DocNodeVariant *parent) |
bool | isPreformatted () const |
Private Attributes | |
DocNodeList | m_paragraphs |
DocNodeList | m_params |
DocNodeList | m_paramTypes |
DocParamSect::Type | m_type = DocParamSect::Unknown |
DocParamSect::Direction | m_dir = DocParamSect::Unspecified |
bool | m_isFirst = false |
bool | m_isLast = false |
Additional Inherited Members | |
Protected Types inherited from DocNode | |
enum | RefType { Unknown , Anchor , Section , Table } |
Protected Member Functions inherited from DocNode | |
void | setInsidePreformatted (bool p) |
|
inline |
Definition at line 1121 of file docnode.h.
References DocNode::DocNode(), m_dir, m_type, DocNode::parent(), and DocNode::parser().
|
inline |
Definition at line 1127 of file docnode.h.
References m_dir.
Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().
|
inline |
|
inline |
Definition at line 1131 of file docnode.h.
References m_isLast.
Referenced by ManDocVisitor::operator()().
|
inline |
|
inline |
Definition at line 1129 of file docnode.h.
References m_isLast, and TRUE.
Referenced by DocParamSect::parse(), and parseXml().
|
inline |
Definition at line 1125 of file docnode.h.
References m_paragraphs.
Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().
|
inline |
Definition at line 1123 of file docnode.h.
References m_params.
Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().
|
inline |
Definition at line 1124 of file docnode.h.
References m_paramTypes.
Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().
Definition at line 3037 of file docnode.cpp.
References AUTO_TRACE, AUTO_TRACE_EXIT, DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::context, QCString::find(), DocParser::handleLinkedWord(), DocParser::handleParameterType(), DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, Token::is(), Token::is_any_of(), DocTokenizer::lex(), m_paragraphs, m_params, m_paramTypes, m_type, DocPara::markFirst(), DocPara::markLast(), QCString::mid(), TokenInfo::name, DocParamSect::Param, DocNode::parent(), DocPara::parse(), DocNode::parser(), qPrint(), DocParamSect::RetVal, DocTokenizer::setStatePara(), DocTokenizer::setStateParam(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, TRUE, and warn_doc_error.
Definition at line 3116 of file docnode.cpp.
References AUTO_TRACE, AUTO_TRACE_EXIT, DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::context, FALSE, DocParser::handleLinkedWord(), DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), m_paragraphs, m_params, m_type, markFirst(), markLast(), TokenInfo::name, DocParamSect::Param, DocNode::parser(), DocParamSect::RetVal, DocNode::thisVariant(), Token::to_string(), DocParserContext::token, TRUE, warn_doc_error, XML_EXCEPTION, XML_PARAM, and XML_TYPEPARAM.
|
inline |
|
private |
Definition at line 1140 of file docnode.h.
Referenced by direction(), and DocParamList().
|
private |
Definition at line 1141 of file docnode.h.
Referenced by isFirst(), and markFirst().
|
private |
Definition at line 1142 of file docnode.h.
Referenced by isLast(), and markLast().
|
private |
Definition at line 1136 of file docnode.h.
Referenced by paragraphs(), parse(), and parseXml().
|
private |
Definition at line 1137 of file docnode.h.
Referenced by parameters(), parse(), and parseXml().
|
private |
Definition at line 1138 of file docnode.h.
Referenced by paramTypes(), and parse().
|
private |
Definition at line 1139 of file docnode.h.
Referenced by DocParamList(), parse(), parseXml(), and type().