summaryrefslogtreecommitdiffstats
path: root/tools/qdoc3/generator.h
diff options
context:
space:
mode:
Diffstat (limited to 'tools/qdoc3/generator.h')
-rw-r--r--tools/qdoc3/generator.h95
1 files changed, 54 insertions, 41 deletions
diff --git a/tools/qdoc3/generator.h b/tools/qdoc3/generator.h
index 2c06480..3db2d8d 100644
--- a/tools/qdoc3/generator.h
+++ b/tools/qdoc3/generator.h
@@ -70,7 +70,7 @@ class Tree;
class Generator
{
-public:
+ public:
Generator();
virtual ~Generator();
@@ -80,47 +80,57 @@ public:
virtual bool canHandleFormat(const QString &format) { return format == this->format(); }
virtual void generateTree(const Tree *tree, CodeMarker *marker) = 0;
- static void initialize( const Config& config );
+ static void initialize(const Config& config);
static void terminate();
- static Generator *generatorForFormat( const QString& format );
-
-protected:
- virtual void startText( const Node *relative, CodeMarker *marker );
- virtual void endText( const Node *relative, CodeMarker *marker );
- virtual int generateAtom( const Atom *atom, const Node *relative,
- CodeMarker *marker );
+ static Generator *generatorForFormat(const QString& format);
+
+ protected:
+ virtual void startText(const Node *relative, CodeMarker *marker);
+ virtual void endText(const Node *relative, CodeMarker *marker);
+ virtual int generateAtom(const Atom *atom,
+ const Node *relative,
+ CodeMarker *marker);
virtual void generateClassLikeNode(const InnerNode *inner, CodeMarker *marker);
- virtual void generateFakeNode( const FakeNode *fake, CodeMarker *marker );
-
- virtual void generateText( const Text& text, const Node *relative,
- CodeMarker *marker );
- virtual void generateBody( const Node *node, CodeMarker *marker );
- virtual void generateAlsoList( const Node *node, CodeMarker *marker );
- virtual void generateInherits( const ClassNode *classe,
- CodeMarker *marker );
- virtual void generateInheritedBy( const ClassNode *classe,
- CodeMarker *marker );
-
- void generateThreadSafeness( const Node *node, CodeMarker *marker );
+ virtual void generateFakeNode(const FakeNode *fake, CodeMarker *marker);
+
+ virtual void generateText(const Text& text,
+ const Node *relative,
+ CodeMarker *marker);
+#ifdef QDOC_QML
+ virtual void generateQmlText(const Text& text,
+ const Node *relative,
+ CodeMarker *marker);
+#endif
+ virtual void generateBody(const Node *node, CodeMarker *marker);
+ virtual void generateAlsoList(const Node *node, CodeMarker *marker);
+ virtual void generateInherits(const ClassNode *classe,
+ CodeMarker *marker);
+ virtual void generateInheritedBy(const ClassNode *classe,
+ CodeMarker *marker);
+
+ void generateThreadSafeness(const Node *node, CodeMarker *marker);
void generateSince(const Node *node, CodeMarker *marker);
- void generateStatus( const Node *node, CodeMarker *marker );
- const Atom *generateAtomList( const Atom *atom, const Node *relative,
- CodeMarker *marker, bool generate,
- int& numGeneratedAtoms );
+ void generateStatus(const Node *node, CodeMarker *marker);
+ const Atom *generateAtomList(const Atom *atom,
+ const Node *relative,
+ CodeMarker *marker,
+ bool generate,
+ int& numGeneratedAtoms);
void generateExampleFiles(const FakeNode *fake, CodeMarker *marker);
- void generateModuleWarning( const ClassNode *classe, CodeMarker *marker);
+ void generateModuleWarning(const ClassNode *classe, CodeMarker *marker);
virtual int skipAtoms(const Atom *atom, Atom::Type type) const;
- virtual QString fullName(const Node *node, const Node *relative,
+ virtual QString fullName(const Node *node,
+ const Node *relative,
CodeMarker *marker) const;
const QString& outputDir() { return outDir; }
- QString indent( int level, const QString& markedCode );
- QString plainCode( const QString& markedCode );
- virtual QString typeString( const Node *node );
- virtual QString imageFileName( const Node *relative, const QString& fileBase );
- void setImageFileExtensions( const QStringList& extensions );
- void unknownAtom( const Atom *atom );
+ QString indent(int level, const QString& markedCode);
+ QString plainCode(const QString& markedCode);
+ virtual QString typeString(const Node *node);
+ virtual QString imageFileName(const Node *relative, const QString& fileBase);
+ void setImageFileExtensions(const QStringList& extensions);
+ void unknownAtom(const Atom *atom);
QMap<QString, QString> &formattingLeftMap();
QMap<QString, QString> &formattingRightMap();
@@ -128,17 +138,20 @@ protected:
QMap<QString, QStringList> editionGroupMap;
static QString trimmedTrailing(const QString &string);
- static bool matchAhead( const Atom *atom, Atom::Type expectedAtomType );
+ static bool matchAhead(const Atom *atom, Atom::Type expectedAtomType);
static void supplementAlsoList(const Node *node, QList<Text> &alsoList);
private:
- void generateOverload( const Node *node, CodeMarker *marker );
- void generateReimplementedFrom( const FunctionNode *func,
- CodeMarker *marker );
- void appendFullName( Text& text, const Node *apparentNode,
- const Node *relative, CodeMarker *marker,
- const Node *actualNode = 0 );
- void appendSortedNames(Text& text, const ClassNode *classe,
+ void generateOverload(const Node *node, CodeMarker *marker);
+ void generateReimplementedFrom(const FunctionNode *func,
+ CodeMarker *marker);
+ void appendFullName(Text& text,
+ const Node *apparentNode,
+ const Node *relative,
+ CodeMarker *marker,
+ const Node *actualNode = 0);
+ void appendSortedNames(Text& text,
+ const ClassNode *classe,
const QList<RelatedClass> &classes,
CodeMarker *marker);