summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/htmlgenerator.h
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@digia.com>2014-10-09 12:44:07 +0200
committerMartin Smith <martin.smith@digia.com>2014-10-17 10:43:05 +0200
commit4f1de1432c0a028ac68d5a800f3b670ce539d848 (patch)
tree0a99b2361d23b986c62b0b4451eec16b73cc93a2 /src/tools/qdoc/htmlgenerator.h
parent77165553af2e541ca01ec6bf47461ba910d9519b (diff)
qdoc: Generate QA pages
qdoc has a new command line option, -write-qa-pages. Using this flag on the command line will tell qdoc to generate a QA html page in each module's output directory. The QA page contains information that is useful for Quality Assurance checking of the module's docs. The QA file name begins with "aaa" so it will always be listed at the top of the output directory. The file name for the QA file for QtCore, for example, is aaa-qtcore-qa-page.html. Currently, the QA page only contains a report listing the intermodule link count for each module that is the target of links from the documented module. The link report can be used to optimize the search order qdoc uses when resolving inter-module links. By default, the search order is the same as the ordering of the modules in the depends list in the .qdocconf file. Using the report, the user can reorder that list according to the number of links found in each module. i.e. in descending order of link count. The modules are listed in descending order of link count. Additionally, an actual depends variable is printed. It can be cut and pasted into the module's qdocconf file. Change-Id: I442596aeb54dcdd5db4a0821096a5273c15627e6 Task-number: QTBUG-41850 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/tools/qdoc/htmlgenerator.h')
-rw-r--r--src/tools/qdoc/htmlgenerator.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/tools/qdoc/htmlgenerator.h b/src/tools/qdoc/htmlgenerator.h
index 616a989361..825522a121 100644
--- a/src/tools/qdoc/htmlgenerator.h
+++ b/src/tools/qdoc/htmlgenerator.h
@@ -89,6 +89,7 @@ public:
static QString sinceTitle(int i) { return sinceTitles[i]; }
protected:
+ virtual void generateQAPage();
virtual int generateAtom(const Atom *atom,
const Node *relative,
CodeMarker *marker);