summaryrefslogtreecommitdiffstats
path: root/src/qdoc/generator.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/qdoc/generator.h')
-rw-r--r--src/qdoc/generator.h57
1 files changed, 19 insertions, 38 deletions
diff --git a/src/qdoc/generator.h b/src/qdoc/generator.h
index 10fd5131a..6723884f1 100644
--- a/src/qdoc/generator.h
+++ b/src/qdoc/generator.h
@@ -68,11 +68,9 @@ public:
QString fullDocumentLocation(const Node *node, bool useSubdir = false);
const Config *config() { return config_; }
- QString linkForExampleFile(const QString &path,
- const Node *parent,
+ QString linkForExampleFile(const QString &path, const Node *parent,
const QString &fileExt = QString());
- static QString exampleFileTitle(const ExampleNode *relative,
- const QString &fileName);
+ static QString exampleFileTitle(const ExampleNode *relative, const QString &fileName);
static Generator *currentGenerator() { return currentGenerator_; }
static Generator *generatorForFormat(const QString &format);
static void initialize(const Config &config);
@@ -110,7 +108,7 @@ protected:
void endSubPage();
virtual QString fileBase(const Node *node) const;
virtual QString fileExtension() const = 0;
- virtual void generateQAPage() { }
+ virtual void generateQAPage() {}
virtual void generateExampleFilePage(const Node *, const QString &, CodeMarker *) {}
virtual void generateAlsoList(const Node *node, CodeMarker *marker);
virtual int generateAtom(const Atom *, const Node *, CodeMarker *) { return 0; }
@@ -128,9 +126,7 @@ protected:
virtual void generateMaintainerList(const Aggregate *node, CodeMarker *marker);
virtual void generateQmlInheritedBy(const QmlTypeNode *qcn, CodeMarker *marker);
virtual void generateQmlInherits(QmlTypeNode *, CodeMarker *) {}
- virtual bool generateQmlText(const Text &text,
- const Node *relative,
- CodeMarker *marker,
+ virtual bool generateQmlText(const Text &text, const Node *relative, CodeMarker *marker,
const QString &qmlName);
virtual bool generateText(const Text &text, const Node *relative, CodeMarker *marker);
virtual QString imageFileName(const Node *relative, const QString &fileBase);
@@ -142,20 +138,17 @@ protected:
static QString outputSuffix(const Node *node);
static void singularPlural(Text &text, const NodeList &nodes);
static void supplementAlsoList(const Node *node, QVector<Text> &alsoList);
- static QString trimmedTrailing(const QString &string,
- const QString &prefix,
+ static QString trimmedTrailing(const QString &string, const QString &prefix,
const QString &suffix);
void initializeTextOutput();
QString fileName(const Node *node, const QString &extension = QString()) const;
QMap<QString, QString> &formattingLeftMap();
QMap<QString, QString> &formattingRightMap();
- const Atom *generateAtomList(const Atom *atom,
- const Node *relative,
- CodeMarker *marker,
- bool generate,
- int &numGeneratedAtoms);
+ const Atom *generateAtomList(const Atom *atom, const Node *relative, CodeMarker *marker,
+ bool generate, int &numGeneratedAtoms);
void generateRequiredLinks(const Node *node, CodeMarker *marker);
- void generateLinkToExample(const ExampleNode *en, CodeMarker *marker, const QString &exampleUrl);
+ void generateLinkToExample(const ExampleNode *en, CodeMarker *marker,
+ const QString &exampleUrl);
virtual void generateFileList(const ExampleNode *en, CodeMarker *marker, bool images);
static QString formatSince(const Node *node);
void generateSince(const Node *node, CodeMarker *marker);
@@ -168,41 +161,30 @@ protected:
void generateOverloadedSignal(const Node *node, CodeMarker *marker);
static QString getOverloadedSignalCode(const Node *node);
QString indent(int level, const QString &markedCode);
- QTextStream& out();
+ QTextStream &out();
QString outFileName();
- bool parseArg(const QString &src,
- const QString &tag,
- int *pos,
- int n,
- QStringRef *contents,
- QStringRef *par1 = nullptr,
- bool debug = false);
+ bool parseArg(const QString &src, const QString &tag, int *pos, int n, QStringRef *contents,
+ QStringRef *par1 = nullptr, bool debug = false);
void setImageFileExtensions(const QStringList &extensions);
void unknownAtom(const Atom *atom);
int appendSortedQmlNames(Text &text, const Node *base, const NodeList &subs);
- static bool hasExceptions(const Node *node,
- NodeList &reentrant,
- NodeList &threadsafe,
+ static bool hasExceptions(const Node *node, NodeList &reentrant, NodeList &threadsafe,
NodeList &nonreentrant);
QMap<QString, QStringList> editionGroupMap;
QMap<QString, QStringList> editionModuleMap;
QString naturalLanguage;
#ifndef QT_NO_TEXTCODEC
- QTextCodec* outputCodec;
+ QTextCodec *outputCodec;
QString outputEncoding;
#endif
QString tagFile_;
QStack<QTextStream *> outStreamStack;
- void appendFullName(Text &text,
- const Node *apparentNode,
- const Node *relative,
+ void appendFullName(Text &text, const Node *apparentNode, const Node *relative,
const Node *actualNode = nullptr);
- void appendFullName(Text &text,
- const Node *apparentNode,
- const QString &fullName,
+ void appendFullName(Text &text, const Node *apparentNode, const QString &fullName,
const Node *actualNode);
void appendFullNames(Text &text, const NodeList &nodes, const Node *relative);
int appendSortedNames(Text &text, const ClassNode *classe,
@@ -216,8 +198,8 @@ private:
static Generator *currentGenerator_;
static QStringList exampleDirs;
static QStringList exampleImgExts;
- static QMap<QString, QMap<QString, QString> > fmtLeftMaps;
- static QMap<QString, QMap<QString, QString> > fmtRightMaps;
+ static QMap<QString, QMap<QString, QString>> fmtLeftMaps;
+ static QMap<QString, QMap<QString, QString>> fmtRightMaps;
static QVector<Generator *> generators;
static QStringList imageDirs;
static QStringList imageFiles;
@@ -246,8 +228,7 @@ private:
void generateReimplementsClause(const FunctionNode *fn, CodeMarker *marker);
static bool compareNodes(Node *a, Node *b) { return (a->name() < b->name()); }
static bool comparePaths(QString a, QString b) { return (a < b); }
- static void copyTemplateFiles(const Config &config,
- const QString &configVar,
+ static void copyTemplateFiles(const Config &config, const QString &configVar,
const QString &subDir);
protected: