 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include "clangcodeparser.h"#include "codemarker.h"#include "codeparser.h"#include "config.h"#include "cppcodemarker.h"#include "doc.h"#include "docbookgenerator.h"#include "htmlgenerator.h"#include "location.h"#include "puredocparser.h"#include "qdocdatabase.h"#include "qmlcodemarker.h"#include "qmlcodeparser.h"#include "sourcefileparser.h"#include "utilities.h"#include "tokenizer.h"#include "tree.h"#include "webxmlgenerator.h"#include "filesystem/fileresolver.h"#include "boundaries/filesystem/directorypath.h"#include <QtCore/qcompilerdetection.h>#include <QtCore/qdatetime.h>#include <QtCore/qdebug.h>#include <QtCore/qglobal.h>#include <QtCore/qhashfunctions.h>#include <set>#include <QtCore/qcoreapplication.h>#include <algorithm>#include <cstdlib>
Include dependency graph for main.cpp:Go to the source code of this file.
Functions | |
| bool | creationTimeBefore (const QFileInfo &fi1, const QFileInfo &fi2) |
| static void | parseSourceFiles (std::vector< QString > &&sources, SourceFileParser &source_file_parser, CppCodeParser &cpp_code_parser) |
| static void | loadIndexFiles (const QSet< QString > &formats) |
| Read some XML indexes containing definitions from other documentation sets. | |
| void | logStartEndMessage (const QLatin1String &startStop, Config &config) |
| static void | processQdocconfFile (const QString &fileName) |
| Processes the qdoc config file fileName. | |
| static void | clearModuleDependenciesAndProcessQdocconfFile (const QStringList &qdocFiles) |
| static void | singleExecutionMode () |
| static void | dualExecutionMode () |
| QT_END_NAMESPACE int | main (int argc, char **argv) |
| [48] | |
|
static |
For each file in qdocFiles, first clear the configured module dependencies and then pass the file to processQdocconfFile().
|
static |
Process each .qdocconf-file passed as command line argument(s).
Definition at line 664 of file main.cpp.
Referenced by main().
Here is the caller graph for this function:Read some XML indexes containing definitions from other documentation sets.
config contains a variable that lists directories where index files can be found. It also contains the depends variable, which lists the modules that the current module depends on. formats contains a list of output formats; each format may have a different output subdirectory where index files are located.
Definition at line 121 of file main.cpp.
References Location::Location(), ConfigVar::asBool(), and QDocDatabase::qdocDB().
Here is the call graph for this function:| void logStartEndMessage | ( | const QLatin1String & | startStop, |
| Config & | config ) |
Prints to stderr the name of the project that QDoc is running for, in which mode and which phase.
If QDoc is not running in debug mode or –log-progress command line option is not set, do nothing.
Definition at line 273 of file main.cpp.
References ConfigVar::asBool().
Here is the call graph for this function:| QT_END_NAMESPACE int main | ( | int | argc, |
| char ** | argv ) |
[48]
[dynamic_tooltip]
[5]
[2]
[0]
[6]
[48]
[48]
[6]
[0]
[0]
[1]
[1]
[2]
[2]
[3]
[3]
[0]
[0]
[1]
[1]
[2]
[2]
[3]
[3]
[0]
[0]
[1]
[1]
[2]
[2]
[3]
[3]
[0]
[0]
[0]
[0]
[1]
[1]
[1]
[1]
[0]
[0]
[0]
[0]
[0]
[0]
[0]
[0]
Definition at line 672 of file main.cpp.
References QDocDatabase::destroyQdocDB(), dualExecutionMode(), Location::exitCode(), singleExecutionMode(), and QmlTypeNode::terminate().
Here is the call graph for this function:
|
static |
Inspects each file path in sources. File paths with a known source file type are parsed to extract user-provided documentation and information about source code level elements.
The validity or availability of the file paths may or may not cause QDoc to generate warnings; this depends on the implementation of parseSourceFile() for the relevant parser.
Definition at line 64 of file main.cpp.
References CodeParser::parserForSourceFile(), and CppCodeParser::processMetaCommands().
Here is the call graph for this function:Processes the qdoc config file fileName.
This is the controller for all of QDoc. The config instance represents the configuration data for QDoc. All other classes are initialized with the same config.
Definition at line 295 of file main.cpp.
References CppCodeParser::CppCodeParser(), DocBookGenerator::DocBookGenerator(), HtmlGenerator::HtmlGenerator(), PureDocParser::PureDocParser(), SourceFileParser::SourceFileParser(), WebXMLGenerator::WebXMLGenerator(), QDocDatabase::clearSearchOrder(), Utilities::debugging(), Config::dot, Config::dualExec(), Config::getDebug(), Config::getExcludedPaths(), Config::IncludePaths, CodeMarker::initialize(), CodeParser::initialize(), Doc::initialize(), Generator::initialize(), Location::initialize(), Tokenizer::initialize(), Config::location(), Config::preparing(), QDocDatabase::primaryTreeRoot(), QDocDatabase::qdocDB(), QDocDatabase::resolveStuff(), Config::singleExec(), CodeMarker::terminate(), CodeParser::terminate(), Doc::terminate(), Generator::terminate(), Location::terminate(), Tokenizer::terminate(), and NamespaceNode::tree().
Here is the call graph for this function:
|
static |
A single QDoc process for prepare and generate phases. The purpose is to first generate all index files for all documentation projects that combined make out the documentation set being generated. This allows QDoc to link to all content contained in all projects, e.g. user-defined types or overview documentation, regardless of the project that content belongs to when generating the final output.
Definition at line 647 of file main.cpp.
References QDocDatabase::processForest(), and QDocDatabase::qdocDB().
Referenced by main().
Here is the call graph for this function: Here is the caller graph for this function:
1.12.0