summaryrefslogtreecommitdiffstats
path: root/src/docparser.h
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2003-08-08 12:54:22 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2003-08-08 12:54:22 (GMT)
commitd09056a74447fe1c841ffd469986afdffd99765b (patch)
tree7c2d3f65b509d762729291b5341f0751138192fd /src/docparser.h
parent8c1096fc0147c36d3e026ec093b2c5f9158ae01d (diff)
downloadDoxygen-d09056a74447fe1c841ffd469986afdffd99765b.zip
Doxygen-d09056a74447fe1c841ffd469986afdffd99765b.tar.gz
Doxygen-d09056a74447fe1c841ffd469986afdffd99765b.tar.bz2
Release-1.3.3-20030808
Diffstat (limited to 'src/docparser.h')
-rw-r--r--src/docparser.h24
1 files changed, 13 insertions, 11 deletions
diff --git a/src/docparser.h b/src/docparser.h
index 1554037..6b79220 100644
--- a/src/docparser.h
+++ b/src/docparser.h
@@ -36,24 +36,28 @@ class SectionDict;
//---------------------------------------------------------------------------
+/*! Initialize the documentation parser */
+void initDocParser();
+
/*! Main entry point for the documentation parser.
* @param fileName File in which the documentation block is found (or the
* name of the example file in case isExample is TRUE).
* @param startLine Line at which the documentation block is found.
- * @param context Class or namespace in which of the item to which this
- * block belongs.
+ * @param context Class or namespace to which this block belongs.
* @param md Member definition to which the documentation belongs.
* Can be 0.
* @param input String representation of the documentation block.
+ * @param indexWords Indicates whether or not words should be put in the
+ * search index.
* @param isExample TRUE if the documentation belongs to an example.
* @param exampleName Base name of the example file (0 if isExample is FALSE).
* @returns Root node of the abstract syntax tree. Ownership of the
* pointer is handed over to the caller.
*/
DocNode *validatingParseDoc(const char *fileName,int startLine,
- const char *context, MemberDef *md,
- const char *input,bool isExample,
- const char *exampleName=0);
+ Definition *context, MemberDef *md,
+ const char *input,bool indexWords,
+ bool isExample,const char *exampleName=0);
/*! Main entry point for parsing simple text fragments. These
* fragments are limited to words, whitespace and symbols.
@@ -176,8 +180,7 @@ template<class T> class CompAccept
class DocWord : public DocNode
{
public:
- DocWord(DocNode *parent,const QString &word) :
- m_parent(parent), m_word(word) {}
+ DocWord(DocNode *parent,const QString &word);
QString word() const { return m_word; }
Kind kind() const { return Kind_Word; }
DocNode *parent() const { return m_parent; }
@@ -195,9 +198,7 @@ class DocLinkedWord : public DocNode
public:
DocLinkedWord(DocNode *parent,const QString &word,
const QString &ref,const QString &file,
- const QString &anchor) :
- m_parent(parent), m_word(word), m_ref(ref),
- m_file(file), m_anchor(anchor) {}
+ const QString &anchor);
QString word() const { return m_word; }
Kind kind() const { return Kind_Word; }
DocNode *parent() const { return m_parent; }
@@ -312,7 +313,7 @@ class DocSymbol : public DocNode
public:
enum SymType { Unknown=0, BSlash,At,Less,Greater,Amp,Dollar,Hash,Percent,
Copy, Tm, Reg, Apos, Quot, Uml, Acute, Grave, Circ, Tilde, Szlig,
- Cedil, Ring, Nbsp
+ Cedil, Ring, Nbsp, Slash
};
DocSymbol(DocNode *parent,SymType s,char letter='\0') :
m_parent(parent), m_symbol(s), m_letter(letter) {}
@@ -923,6 +924,7 @@ class DocPara : public CompAccept<DocPara>, public DocNode
void markLast(bool v=TRUE) { m_isLast=v; }
bool isFirst() const { return m_isFirst; }
bool isLast() const { return m_isLast; }
+ const QList<DocNode> &children() const { return m_children; }
int handleCommand(const QString &cmdName);
int handleHtmlStartTag(const QString &tagName,const HtmlAttribList &tagHtmlAttribs);