|
|
              
Configuration File Exampleconfiguration files for the QDoc Manual and QDoc Guide The QDoc Manual uses these qdocconf files to generate the QDoc Guide and the QDoc Manual. Note: The configuration files are similar to the Qt Reference Documentation and the QDoc Manual do not use all of the variables. The variables are included to demonstrate a full project scenario. Macros and other Definitions
QDoc allows macros to help with aliasing and for inputting special HTML characters within the documentation. Macros are a form of workarounds if QDoc is unable to resolve formatting issues such as when QDoc should disregard QDoc comments in documentation paragraphs. QDoc is also aware of the common C++ and Qt preprocessors and can decide which documentation to generate according to the definitions in the configuration files. Project Information
These configuration files dictate how QDoc will generate the project. Depending which configuration file QDoc processes, the formatting and the information about the project will be different. If QDoc processes qdoc-online.qdocconf, QDoc will generate the HTML version of the manual will have the style suitable for online viewing. Additionally, the settings for creating the Qt Help File is in the configuration. Note: The project file uses variables used during Qt's configuration step. HTML Styles
These files indicate which styles QDoc should use for the HTML formats. Typically, there are two templates, one for online viewing and one for offline. Qt Creator is able to fit more content in a page with the offline template. The templates store HTML information as strings and QDoc will copy the template to each HTML page. Project File
Every example page (such as this one) needs a Qt project file. QDoc will use the project file to determine which files are part of the example. QDoc will then create a page listing all the files that are part of the example. Note: the directory name of the example and the name of the project file must match. The example directory is found using the exampledirs variable. |
