doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

TextDocVisitor Class Reference

Copyright (C) 1997-2015 by Dimitri van Heesch. More...

#include <textdocvisitor.h>

+ Inheritance diagram for TextDocVisitor:
+ Collaboration diagram for TextDocVisitor:

Public Member Functions

 TextDocVisitor (FTextStream &t)
 
void visit (DocWord *w)
 
void visit (DocLinkedWord *w)
 
void visit (DocWhiteSpace *)
 
void visit (DocSymbol *)
 Copyright (C) 1997-2015 by Dimitri van Heesch. More...
 
void visit (DocEmoji *)
 
void visit (DocURL *u)
 
void visit (DocLineBreak *)
 
void visit (DocHorRuler *)
 
void visit (DocStyleChange *)
 
void visit (DocVerbatim *s)
 
void visit (DocAnchor *)
 
void visit (DocInclude *)
 
void visit (DocIncOperator *)
 
void visit (DocFormula *)
 
void visit (DocIndexEntry *)
 
void visit (DocSimpleSectSep *)
 
void visit (DocCite *)
 
void visitPre (DocAutoList *)
 
void visitPost (DocAutoList *)
 
void visitPre (DocAutoListItem *)
 
void visitPost (DocAutoListItem *)
 
void visitPre (DocPara *)
 
void visitPost (DocPara *)
 
void visitPre (DocRoot *)
 
void visitPost (DocRoot *)
 
void visitPre (DocSimpleSect *)
 
void visitPost (DocSimpleSect *)
 
void visitPre (DocTitle *)
 
void visitPost (DocTitle *)
 
void visitPre (DocSimpleList *)
 
void visitPost (DocSimpleList *)
 
void visitPre (DocSimpleListItem *)
 
void visitPost (DocSimpleListItem *)
 
void visitPre (DocSection *)
 
void visitPost (DocSection *)
 
void visitPre (DocHtmlList *)
 
void visitPost (DocHtmlList *)
 
void visitPre (DocHtmlListItem *)
 
void visitPost (DocHtmlListItem *)
 
void visitPre (DocHtmlDescList *)
 
void visitPost (DocHtmlDescList *)
 
void visitPre (DocHtmlDescTitle *)
 
void visitPost (DocHtmlDescTitle *)
 
void visitPre (DocHtmlDescData *)
 
void visitPost (DocHtmlDescData *)
 
void visitPre (DocHtmlTable *)
 
void visitPost (DocHtmlTable *)
 
void visitPre (DocHtmlRow *)
 
void visitPost (DocHtmlRow *)
 
void visitPre (DocHtmlCell *)
 
void visitPost (DocHtmlCell *)
 
void visitPre (DocHtmlCaption *)
 
void visitPost (DocHtmlCaption *)
 
void visitPre (DocInternal *)
 
void visitPost (DocInternal *)
 
void visitPre (DocHRef *)
 
void visitPost (DocHRef *)
 
void visitPre (DocHtmlHeader *)
 
void visitPost (DocHtmlHeader *)
 
void visitPre (DocImage *)
 
void visitPost (DocImage *)
 
void visitPre (DocDotFile *)
 
void visitPost (DocDotFile *)
 
void visitPre (DocMscFile *)
 
void visitPost (DocMscFile *)
 
void visitPre (DocDiaFile *)
 
void visitPost (DocDiaFile *)
 
void visitPre (DocLink *)
 
void visitPost (DocLink *)
 
void visitPre (DocRef *)
 
void visitPost (DocRef *)
 
void visitPre (DocSecRefItem *)
 
void visitPost (DocSecRefItem *)
 
void visitPre (DocSecRefList *)
 
void visitPost (DocSecRefList *)
 
void visitPre (DocParamSect *)
 
void visitPost (DocParamSect *)
 
void visitPre (DocParamList *)
 
void visitPost (DocParamList *)
 
void visitPre (DocXRefItem *)
 
void visitPost (DocXRefItem *)
 
void visitPre (DocInternalRef *)
 
void visitPost (DocInternalRef *)
 
void visitPre (DocText *)
 
void visitPost (DocText *)
 
void visitPre (DocHtmlBlockQuote *)
 
void visitPost (DocHtmlBlockQuote *)
 
void visitPre (DocVhdlFlow *)
 
void visitPost (DocVhdlFlow *)
 
void visitPre (DocParBlock *)
 
void visitPost (DocParBlock *)
 
- Public Member Functions inherited from DocVisitor
 DocVisitor (int id)
 
virtual ~DocVisitor ()
 
int id () const
 

Private Member Functions

void filter (const char *str)
 

Private Attributes

FTextStreamm_t
 

Detailed Description

Copyright (C) 1997-2015 by Dimitri van Heesch.

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by Doxygen are derivative works derived from the input used in their production; they are not affected by this license.

Concrete visitor implementation for TEXT output.

Definition at line 30 of file textdocvisitor.h.

Constructor & Destructor Documentation

◆ TextDocVisitor()

TextDocVisitor::TextDocVisitor ( FTextStream t)
inline

Definition at line 33 of file textdocvisitor.h.

Member Function Documentation

◆ filter()

void TextDocVisitor::filter ( const char *  str)
private

Definition at line 54 of file textdocvisitor.cpp.

References m_t.

Referenced by visit().

◆ visit() [1/17]

void TextDocVisitor::visit ( DocAnchor )
inlinevirtual

Implements DocVisitor.

Definition at line 49 of file textdocvisitor.h.

◆ visit() [2/17]

void TextDocVisitor::visit ( DocCite )
inlinevirtual

Implements DocVisitor.

Definition at line 55 of file textdocvisitor.h.

◆ visit() [3/17]

void TextDocVisitor::visit ( DocEmoji s)
virtual

◆ visit() [4/17]

void TextDocVisitor::visit ( DocFormula )
inlinevirtual

Implements DocVisitor.

Definition at line 52 of file textdocvisitor.h.

◆ visit() [5/17]

void TextDocVisitor::visit ( DocHorRuler )
inlinevirtual

Implements DocVisitor.

Definition at line 46 of file textdocvisitor.h.

◆ visit() [6/17]

void TextDocVisitor::visit ( DocInclude )
inlinevirtual

Implements DocVisitor.

Definition at line 50 of file textdocvisitor.h.

◆ visit() [7/17]

void TextDocVisitor::visit ( DocIncOperator )
inlinevirtual

Implements DocVisitor.

Definition at line 51 of file textdocvisitor.h.

◆ visit() [8/17]

void TextDocVisitor::visit ( DocIndexEntry )
inlinevirtual

Implements DocVisitor.

Definition at line 53 of file textdocvisitor.h.

◆ visit() [9/17]

void TextDocVisitor::visit ( DocLineBreak )
inlinevirtual

Implements DocVisitor.

Definition at line 45 of file textdocvisitor.h.

References m_t.

◆ visit() [10/17]

void TextDocVisitor::visit ( DocLinkedWord w)
inlinevirtual

Implements DocVisitor.

Definition at line 40 of file textdocvisitor.h.

References filter(), and DocLinkedWord::word().

◆ visit() [11/17]

void TextDocVisitor::visit ( DocSimpleSectSep )
inlinevirtual

Implements DocVisitor.

Definition at line 54 of file textdocvisitor.h.

◆ visit() [12/17]

void TextDocVisitor::visit ( DocStyleChange )
inlinevirtual

Implements DocVisitor.

Definition at line 47 of file textdocvisitor.h.

◆ visit() [13/17]

void TextDocVisitor::visit ( DocSymbol s)
virtual

Copyright (C) 1997-2015 by Dimitri van Heesch.

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by Doxygen are derivative works derived from the input used in their production; they are not affected by this license.

Implements DocVisitor.

Definition at line 28 of file textdocvisitor.cpp.

References err(), HtmlEntityMapper::html(), HtmlEntityMapper::instance(), m_t, DocSymbol::symbol(), and TRUE.

◆ visit() [14/17]

void TextDocVisitor::visit ( DocURL u)
inlinevirtual

Implements DocVisitor.

Definition at line 44 of file textdocvisitor.h.

References filter(), and DocURL::url().

◆ visit() [15/17]

void TextDocVisitor::visit ( DocVerbatim s)
inlinevirtual

Implements DocVisitor.

Definition at line 48 of file textdocvisitor.h.

References filter(), and DocVerbatim::text().

◆ visit() [16/17]

void TextDocVisitor::visit ( DocWhiteSpace )
inlinevirtual

Implements DocVisitor.

Definition at line 41 of file textdocvisitor.h.

References m_t.

◆ visit() [17/17]

void TextDocVisitor::visit ( DocWord w)
inlinevirtual

Implements DocVisitor.

Definition at line 39 of file textdocvisitor.h.

References filter(), and DocWord::word().

◆ visitPost() [1/37]

void TextDocVisitor::visitPost ( DocAutoList )
inlinevirtual

Implements DocVisitor.

Definition at line 62 of file textdocvisitor.h.

◆ visitPost() [2/37]

void TextDocVisitor::visitPost ( DocAutoListItem )
inlinevirtual

Implements DocVisitor.

Definition at line 64 of file textdocvisitor.h.

◆ visitPost() [3/37]

void TextDocVisitor::visitPost ( DocDiaFile )
inlinevirtual

Implements DocVisitor.

Definition at line 111 of file textdocvisitor.h.

◆ visitPost() [4/37]

void TextDocVisitor::visitPost ( DocDotFile )
inlinevirtual

Implements DocVisitor.

Definition at line 106 of file textdocvisitor.h.

◆ visitPost() [5/37]

void TextDocVisitor::visitPost ( DocHRef )
inlinevirtual

Implements DocVisitor.

Definition at line 100 of file textdocvisitor.h.

◆ visitPost() [6/37]

void TextDocVisitor::visitPost ( DocHtmlBlockQuote )
inlinevirtual

Implements DocVisitor.

Definition at line 131 of file textdocvisitor.h.

◆ visitPost() [7/37]

void TextDocVisitor::visitPost ( DocHtmlCaption )
inlinevirtual

Implements DocVisitor.

Definition at line 96 of file textdocvisitor.h.

◆ visitPost() [8/37]

void TextDocVisitor::visitPost ( DocHtmlCell )
inlinevirtual

Implements DocVisitor.

Definition at line 94 of file textdocvisitor.h.

◆ visitPost() [9/37]

void TextDocVisitor::visitPost ( DocHtmlDescData )
inlinevirtual

Implements DocVisitor.

Definition at line 88 of file textdocvisitor.h.

◆ visitPost() [10/37]

void TextDocVisitor::visitPost ( DocHtmlDescList )
inlinevirtual

Implements DocVisitor.

Definition at line 84 of file textdocvisitor.h.

◆ visitPost() [11/37]

void TextDocVisitor::visitPost ( DocHtmlDescTitle )
inlinevirtual

Implements DocVisitor.

Definition at line 86 of file textdocvisitor.h.

◆ visitPost() [12/37]

void TextDocVisitor::visitPost ( DocHtmlHeader )
inlinevirtual

Implements DocVisitor.

Definition at line 102 of file textdocvisitor.h.

◆ visitPost() [13/37]

void TextDocVisitor::visitPost ( DocHtmlList )
inlinevirtual

Implements DocVisitor.

Definition at line 80 of file textdocvisitor.h.

◆ visitPost() [14/37]

void TextDocVisitor::visitPost ( DocHtmlListItem )
inlinevirtual

Implements DocVisitor.

Definition at line 82 of file textdocvisitor.h.

◆ visitPost() [15/37]

void TextDocVisitor::visitPost ( DocHtmlRow )
inlinevirtual

Implements DocVisitor.

Definition at line 92 of file textdocvisitor.h.

◆ visitPost() [16/37]

void TextDocVisitor::visitPost ( DocHtmlTable )
inlinevirtual

Implements DocVisitor.

Definition at line 90 of file textdocvisitor.h.

◆ visitPost() [17/37]

void TextDocVisitor::visitPost ( DocImage )
inlinevirtual

Implements DocVisitor.

Definition at line 104 of file textdocvisitor.h.

◆ visitPost() [18/37]

void TextDocVisitor::visitPost ( DocInternal )
inlinevirtual

Implements DocVisitor.

Definition at line 98 of file textdocvisitor.h.

◆ visitPost() [19/37]

void TextDocVisitor::visitPost ( DocInternalRef )
inlinevirtual

Implements DocVisitor.

Definition at line 127 of file textdocvisitor.h.

◆ visitPost() [20/37]

void TextDocVisitor::visitPost ( DocLink )
inlinevirtual

Implements DocVisitor.

Definition at line 113 of file textdocvisitor.h.

◆ visitPost() [21/37]

void TextDocVisitor::visitPost ( DocMscFile )
inlinevirtual

Implements DocVisitor.

Definition at line 109 of file textdocvisitor.h.

◆ visitPost() [22/37]

void TextDocVisitor::visitPost ( DocPara )
inlinevirtual

Implements DocVisitor.

Definition at line 66 of file textdocvisitor.h.

◆ visitPost() [23/37]

void TextDocVisitor::visitPost ( DocParamList )
inlinevirtual

Implements DocVisitor.

Definition at line 123 of file textdocvisitor.h.

◆ visitPost() [24/37]

void TextDocVisitor::visitPost ( DocParamSect )
inlinevirtual

Implements DocVisitor.

Definition at line 121 of file textdocvisitor.h.

◆ visitPost() [25/37]

void TextDocVisitor::visitPost ( DocParBlock )
inlinevirtual

Implements DocVisitor.

Definition at line 135 of file textdocvisitor.h.

◆ visitPost() [26/37]

void TextDocVisitor::visitPost ( DocRef )
inlinevirtual

Implements DocVisitor.

Definition at line 115 of file textdocvisitor.h.

◆ visitPost() [27/37]

void TextDocVisitor::visitPost ( DocRoot )
inlinevirtual

Implements DocVisitor.

Definition at line 68 of file textdocvisitor.h.

◆ visitPost() [28/37]

void TextDocVisitor::visitPost ( DocSecRefItem )
inlinevirtual

Implements DocVisitor.

Definition at line 117 of file textdocvisitor.h.

◆ visitPost() [29/37]

void TextDocVisitor::visitPost ( DocSecRefList )
inlinevirtual

Implements DocVisitor.

Definition at line 119 of file textdocvisitor.h.

◆ visitPost() [30/37]

void TextDocVisitor::visitPost ( DocSection )
inlinevirtual

Implements DocVisitor.

Definition at line 78 of file textdocvisitor.h.

◆ visitPost() [31/37]

void TextDocVisitor::visitPost ( DocSimpleList )
inlinevirtual

Implements DocVisitor.

Definition at line 74 of file textdocvisitor.h.

◆ visitPost() [32/37]

void TextDocVisitor::visitPost ( DocSimpleListItem )
inlinevirtual

Implements DocVisitor.

Definition at line 76 of file textdocvisitor.h.

◆ visitPost() [33/37]

void TextDocVisitor::visitPost ( DocSimpleSect )
inlinevirtual

Implements DocVisitor.

Definition at line 70 of file textdocvisitor.h.

◆ visitPost() [34/37]

void TextDocVisitor::visitPost ( DocText )
inlinevirtual

Implements DocVisitor.

Definition at line 129 of file textdocvisitor.h.

◆ visitPost() [35/37]

void TextDocVisitor::visitPost ( DocTitle )
inlinevirtual

Implements DocVisitor.

Definition at line 72 of file textdocvisitor.h.

◆ visitPost() [36/37]

void TextDocVisitor::visitPost ( DocVhdlFlow )
inlinevirtual

Implements DocVisitor.

Definition at line 133 of file textdocvisitor.h.

◆ visitPost() [37/37]

void TextDocVisitor::visitPost ( DocXRefItem )
inlinevirtual

Implements DocVisitor.

Definition at line 125 of file textdocvisitor.h.

◆ visitPre() [1/37]

void TextDocVisitor::visitPre ( DocAutoList )
inlinevirtual

Implements DocVisitor.

Definition at line 61 of file textdocvisitor.h.

◆ visitPre() [2/37]

void TextDocVisitor::visitPre ( DocAutoListItem )
inlinevirtual

Implements DocVisitor.

Definition at line 63 of file textdocvisitor.h.

◆ visitPre() [3/37]

void TextDocVisitor::visitPre ( DocDiaFile )
inlinevirtual

Implements DocVisitor.

Definition at line 110 of file textdocvisitor.h.

◆ visitPre() [4/37]

void TextDocVisitor::visitPre ( DocDotFile )
inlinevirtual

Implements DocVisitor.

Definition at line 105 of file textdocvisitor.h.

◆ visitPre() [5/37]

void TextDocVisitor::visitPre ( DocHRef )
inlinevirtual

Implements DocVisitor.

Definition at line 99 of file textdocvisitor.h.

◆ visitPre() [6/37]

void TextDocVisitor::visitPre ( DocHtmlBlockQuote )
inlinevirtual

Implements DocVisitor.

Definition at line 130 of file textdocvisitor.h.

◆ visitPre() [7/37]

void TextDocVisitor::visitPre ( DocHtmlCaption )
inlinevirtual

Implements DocVisitor.

Definition at line 95 of file textdocvisitor.h.

◆ visitPre() [8/37]

void TextDocVisitor::visitPre ( DocHtmlCell )
inlinevirtual

Implements DocVisitor.

Definition at line 93 of file textdocvisitor.h.

◆ visitPre() [9/37]

void TextDocVisitor::visitPre ( DocHtmlDescData )
inlinevirtual

Implements DocVisitor.

Definition at line 87 of file textdocvisitor.h.

◆ visitPre() [10/37]

void TextDocVisitor::visitPre ( DocHtmlDescList )
inlinevirtual

Implements DocVisitor.

Definition at line 83 of file textdocvisitor.h.

◆ visitPre() [11/37]

void TextDocVisitor::visitPre ( DocHtmlDescTitle )
inlinevirtual

Implements DocVisitor.

Definition at line 85 of file textdocvisitor.h.

◆ visitPre() [12/37]

void TextDocVisitor::visitPre ( DocHtmlHeader )
inlinevirtual

Implements DocVisitor.

Definition at line 101 of file textdocvisitor.h.

◆ visitPre() [13/37]

void TextDocVisitor::visitPre ( DocHtmlList )
inlinevirtual

Implements DocVisitor.

Definition at line 79 of file textdocvisitor.h.

◆ visitPre() [14/37]

void TextDocVisitor::visitPre ( DocHtmlListItem )
inlinevirtual

Implements DocVisitor.

Definition at line 81 of file textdocvisitor.h.

◆ visitPre() [15/37]

void TextDocVisitor::visitPre ( DocHtmlRow )
inlinevirtual

Implements DocVisitor.

Definition at line 91 of file textdocvisitor.h.

◆ visitPre() [16/37]

void TextDocVisitor::visitPre ( DocHtmlTable )
inlinevirtual

Implements DocVisitor.

Definition at line 89 of file textdocvisitor.h.

◆ visitPre() [17/37]

void TextDocVisitor::visitPre ( DocImage )
inlinevirtual

Implements DocVisitor.

Definition at line 103 of file textdocvisitor.h.

◆ visitPre() [18/37]

void TextDocVisitor::visitPre ( DocInternal )
inlinevirtual

Implements DocVisitor.

Definition at line 97 of file textdocvisitor.h.

◆ visitPre() [19/37]

void TextDocVisitor::visitPre ( DocInternalRef )
inlinevirtual

Implements DocVisitor.

Definition at line 126 of file textdocvisitor.h.

◆ visitPre() [20/37]

void TextDocVisitor::visitPre ( DocLink )
inlinevirtual

Implements DocVisitor.

Definition at line 112 of file textdocvisitor.h.

◆ visitPre() [21/37]

void TextDocVisitor::visitPre ( DocMscFile )
inlinevirtual

Implements DocVisitor.

Definition at line 108 of file textdocvisitor.h.

◆ visitPre() [22/37]

void TextDocVisitor::visitPre ( DocPara )
inlinevirtual

Implements DocVisitor.

Definition at line 65 of file textdocvisitor.h.

◆ visitPre() [23/37]

void TextDocVisitor::visitPre ( DocParamList )
inlinevirtual

Implements DocVisitor.

Definition at line 122 of file textdocvisitor.h.

◆ visitPre() [24/37]

void TextDocVisitor::visitPre ( DocParamSect )
inlinevirtual

Implements DocVisitor.

Definition at line 120 of file textdocvisitor.h.

◆ visitPre() [25/37]

void TextDocVisitor::visitPre ( DocParBlock )
inlinevirtual

Implements DocVisitor.

Definition at line 134 of file textdocvisitor.h.

◆ visitPre() [26/37]

void TextDocVisitor::visitPre ( DocRef )
inlinevirtual

Implements DocVisitor.

Definition at line 114 of file textdocvisitor.h.

◆ visitPre() [27/37]

void TextDocVisitor::visitPre ( DocRoot )
inlinevirtual

Implements DocVisitor.

Definition at line 67 of file textdocvisitor.h.

◆ visitPre() [28/37]

void TextDocVisitor::visitPre ( DocSecRefItem )
inlinevirtual

Implements DocVisitor.

Definition at line 116 of file textdocvisitor.h.

◆ visitPre() [29/37]

void TextDocVisitor::visitPre ( DocSecRefList )
inlinevirtual

Implements DocVisitor.

Definition at line 118 of file textdocvisitor.h.

◆ visitPre() [30/37]

void TextDocVisitor::visitPre ( DocSection )
inlinevirtual

Implements DocVisitor.

Definition at line 77 of file textdocvisitor.h.

◆ visitPre() [31/37]

void TextDocVisitor::visitPre ( DocSimpleList )
inlinevirtual

Implements DocVisitor.

Definition at line 73 of file textdocvisitor.h.

◆ visitPre() [32/37]

void TextDocVisitor::visitPre ( DocSimpleListItem )
inlinevirtual

Implements DocVisitor.

Definition at line 75 of file textdocvisitor.h.

◆ visitPre() [33/37]

void TextDocVisitor::visitPre ( DocSimpleSect )
inlinevirtual

Implements DocVisitor.

Definition at line 69 of file textdocvisitor.h.

◆ visitPre() [34/37]

void TextDocVisitor::visitPre ( DocText )
inlinevirtual

Implements DocVisitor.

Definition at line 128 of file textdocvisitor.h.

◆ visitPre() [35/37]

void TextDocVisitor::visitPre ( DocTitle )
inlinevirtual

Implements DocVisitor.

Definition at line 71 of file textdocvisitor.h.

◆ visitPre() [36/37]

void TextDocVisitor::visitPre ( DocVhdlFlow )
inlinevirtual

Implements DocVisitor.

Definition at line 132 of file textdocvisitor.h.

◆ visitPre() [37/37]

void TextDocVisitor::visitPre ( DocXRefItem )
inlinevirtual

Implements DocVisitor.

Definition at line 124 of file textdocvisitor.h.

Member Data Documentation

◆ m_t

FTextStream& TextDocVisitor::m_t
private

Definition at line 141 of file textdocvisitor.h.

Referenced by filter(), and visit().


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