summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-02-16 07:45:34 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-02-16 07:45:34 (GMT)
commitdbcd9010be5dc92a7a9d15badf008fbdb9871007 (patch)
tree3b312676fd64f36a06f21e332f32c86ff277c6f0
parentd543e008d7654c1642e4accafd6c670d514999f9 (diff)
downloadQt-dbcd9010be5dc92a7a9d15badf008fbdb9871007.zip
Qt-dbcd9010be5dc92a7a9d15badf008fbdb9871007.tar.gz
Qt-dbcd9010be5dc92a7a9d15badf008fbdb9871007.tar.bz2
qdoc: Updated the qdoc manual and its config file.
Diffstat
-rwxr-xr-xdoc/src/template/style/style.css2
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc3804
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdocconf110
-rw-r--r--tools/qdoc3/htmlgenerator.cpp20
4 files changed, 1863 insertions, 2073 deletions
diff --git a/doc/src/template/style/style.css b/doc/src/template/style/style.css
index 06de245..58ef13b 100755
--- a/doc/src/template/style/style.css
+++ b/doc/src/template/style/style.css
@@ -7,7 +7,7 @@
color: #000000;
background: #FFFFFF;
}
- body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, code, form, fieldset, legend, input, button, textarea, p, blockquote, th, td
+ body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, code, form, fieldset, legend, input, button, textarea, p, th, td
{
margin: 0;
padding: 0;
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 533e730..12d0085 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -27,364 +27,226 @@
/*!
\page index.html
- \nextpage Introduction
+ \nextpage Introduction to QDoc
\title Table of Contents
\list
- \o \l{Introduction}
- \o \l{QDoc Commands}
- \list
- \o \l{Markup Commands}
- \o \l{Text Formatting Commands} \span {class="newStuff"} {(new commands)}
- \o \l{Document Structuring Commands}
- \o \l{Verbatim Code Commands}
- \o \l{Quoting External Code Commands}
- \list
- \o \l{Example File}
- \endlist
- \o \l{Linking Commands}
- \o \l{Graphic Commands}
- \o \l{Container Commands}
- \o \l{Document Contents Commands}
- \o \l{Miscellaneous Commands}
- \list
- \o \l{signalandslots.qdocinc}
- \o \l{objectmodel.qdocinc}
- \o \l{layoutmanagement.qdocinc}
- \endlist
- \o \l{Topical Commands}
- \o \l{Contextual Commands}
- \o \l{Navigation Commands}
- \o \l{Status Commands}
- \o \l{Thread Support Commands}
- \o \l{Relating Commands}
- \o \l{Grouping Commands}
- \o \l{Title Commands}
- \endlist
- \o \l{QDoc Configuration}
- \list
- \o \l{General Configuration Variables}
- \o \l{Creating Help Project Files}
- \o \l{C++ Specific Configuration Variables}
- \o \l{HTML Specific Configuration Variables}
- \o \l{Supporting Derived Projects}
- \o \l{QDoc Compatibility}
- \o \l{qt.qdocconf}
- \o \l{minimum.qdocconf}
- \endlist
- \o \l{QDoc Commands - Alphabetical List}
+ \o \l {Introduction to QDoc}
+ \o \l {The QDoc Commands}
+ \list
+ \o \l {Topic Commands}
+ \o \l {Context Commands}
+ \list
+ \o \l {Navigating}
+ \o \l {Reporting Status}
+ \o \l {Thread Support}
+ \o \l {Relating Things}
+ \o \l {Grouping Things}
+ \o \l {Naming Things}
+ \endlist
+ \o \l{Markup Commands}
+ \list
+ \o \l {Text Markup} \span {class="newStuff"} {(new: div & span)}
+ \o \l {Document Structure}
+ \o \l {Including Code Inline}
+ \o \l {Including External Code}
+ \o \l {Creating Links}
+ \o \l {Including Images}
+ \o \l {Tables and Lists}
+ \o \l {Special Content}
+ \o \l {Miscellaneous}
+ \endlist
+ \endlist
+ \o \l {The QDoc Configuration File}
+ \list
+ \o \l {General Configuration Variables}
+ \o \l {Creating Help Project Files}
+ \o \l {C++ Specific Configuration Variables}
+ \o \l {HTML Specific Configuration Variables}
+ \o \l {Supporting Derived Projects}
+ \o \l {Compatibility Issues}
+ \o \l {qt.qdocconf}
+ \o \l {minimum.qdocconf}
+ \endlist
\endlist
+
*/
/*!
\page 01-qdoc-manual.html
\contentspage Table of Contents
\previouspage Table of Contents
- \nextpage QDoc Commands
-
- \title Introduction
-
- QDoc is the internal tool used by Qt Development Frameworks for generating
- documentation. This document is a reference for QDoc command syntax and
- configuration.
-
- \section1 Overview
-
- \list I
- \o \section2 \l {QDoc Commands}
-
- \l {QDoc Commands - Alphabetical List} {A complete alphabetical
- list}.
-
- There are two main categories of commands for QDoc: markup
- commands and meta-commands.
-
- The markup commands indicate the generated documentation's
- appearance and logical structure. The meta-commands provide
- information about the document as well as the documented
- item. The meta-commands can be further categorized as topical
- commands and contextual commands.
-
- \list
- \o \l {Markup Commands}
- \list
- \o \l {Text Formatting Commands} {Text Formatting} \span {class="newStuff"} {(new commands)}
- \o \l {Document Structuring Commands} {Document Structuring}
- \o \l {Verbatim Code Commands} {Verbatim Code}
- \o \l {Quoting External Code Commands} {Quoting External Code}
- \o \l {Linking Commands} {Linking}
- \o \l {Graphic Commands} {Graphic}
- \o \l {Container Commands} {Container}
- \o \l {Document Contents Commands} {Document Contents}
- \o \l {Miscellaneous Commands} {Miscellaneous}
- \endlist
- \o \l {Topical Commands}
- \o \l {Contextual Commands}
- \list
- \o \l {Navigation Commands} {Navigation}
- \o \l {Status Commands} {Status}
- \o \l {Thread Support Commands} {Thread Support}
- \o \l {Relating Commands} {Relating}
- \o \l {Grouping Commands} {Grouping}
- \o \l {Title Commands} {Title}
- \endlist
- \endlist
- \endlist
-
- \list II
- \o \section2 \l {QDoc Configuration}
+ \nextpage The QDoc Commands
- When running QDoc to generate the documentation, you must
- specify a configuration file on the command line. The
- configuration file is a list of entries of entries of the form
- "variable = value".
+ \title Introduction to QDoc
- \list
- \o \l {Configuration Variables}
- \o \l {Configuration File Examples}
- \endlist
-
- Some particular configuration variables allow you to use QDoc
- to support Qt-based projects; i.e to make projects, such as Qt
- Solutions, contain references to the online Qt documentation.
-
- \list
- \o \l {Supporting Derived Projects}
- \endlist
+ QDoc is a tool used by Qt Developers to extract \e {qdoc comments}
+ from a set of source files and format them for output as HTML
+ pages or as DITA XML files.. This manual explains how to use the
+ QDoc commands and how to create a QDoc configuration file.
- QDoc is a tool that constantly evolves to suit our needs, for
- that reason there are some compatibility issues between old and
- new practices.
-
- \list
- \o \l {QDoc Compatibility}
- \endlist
- \endlist
-*/
-
-/*!
- \page 02-qdoc-commands.html
- \previouspage Introduction
- \contentspage Table of Contents
- \nextpage Markup Commands
+ \section1 Running QDoc
- \title QDoc Commands
+ QDoc is currently called \c {qdoc3}. To run qdoc3, use the command
+ line:
- There are two main categories of commands for QDoc: markup
- commands and meta-commands.
+ \quotation
+ \bold {/currentdirectory$ qdoc3 config.qdocconf}
+ \endquotation
- The markup commands indicate the generated documentation's visual
- appearance and logical structure. The meta-commands provide
- information about the documentation unit as well as the documented
- item. The meta-commands can be further categorized as topical
- commands and contextual commands.
+ ...where config.qdocconf is your \l{The QDoc Configuration File}
+ {QDoc configuration file}. The main purpose of the configuration
+ file is to tell qdoc3 where to find the source files from which to
+ extract qdoc comments, what kind of output to generate (HTML, DITA
+ XML,...}, and where to put the output. The configuration file also
+ contains other information for qdoc3.
- \section1 Alphabetical List
+ \section1 Command Types
- A complete \l{QDoc Commands - Alphabetical List }
- {alphabetical list of the QDoc commands}.
-
- \section1 Categories
+ QDoc interprets three types of commands:
\list
+ \o \l {Topic Commands}
+ \o \l {Context Commands}
\o \l {Markup Commands}
- \o \l {Topical Commands}
- \o \l {Contextual Commands}
\endlist
+
+ Topic commands identify the entity you are documenting, e.g. a C++
+ class, function, or type, an example, or an extra page of text
+ that doesn't map to any C++ entity.
+
+ Context commands tell QDoc how the entity being documented relates
+ to other documented entities, e.g. next and previous page links or
+ inclusion in page groups or library modules. They can also provide
+ information about the documented entity that QDoc can't get from
+ the source files, e.g. whether the entitity is thread-safe, an
+ overloaded or reimplemented function, or that it has been
+ deprecated.
+
+ Markup commands tell QDoc how text and image elements in the
+ document should be rendered or about the document's outline
+ structure.
*/
/*!
\page 03-qdoc-commands-markup.html
\contentspage Table of Contents
- \previouspage QDoc Commands
- \nextpage Text Formatting Commands
+ \previouspage Naming Things
+ \nextpage Text Markup
\title Markup Commands
The markup commands indicate the generated documentation's visual
appearance and logical structure.
- \section1 Alphabetical List
-
- \l {04-qdoc-commands-textformatting.html#backslash} {\\\\},
- \l {04-qdoc-commands-textformatting.html#a} {\\a},
- \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract},
- \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode},
- \l {04-qdoc-commands-textformatting.html#bold} {\\bold},
- \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief},
- \l {04-qdoc-commands-textformatting.html#c} {\\c},
- \l {09-qdoc-commands-graphic.html#caption} {\\caption},
- \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter},
- \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code},
- \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
- \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)},
- \l {07-0-qdoc-commands-quoting.html#dots} {\\dots},
- \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else},
- \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif},
- \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire},
- \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote},
- \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist},
- \l {10-qdoc-commands-container.html#header} {\\header},
- \l {04-qdoc-commands-textformatting.html#i} {\\i},
- \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if},
- \l {09-qdoc-commands-graphic.html#image} {\\image},
- \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include},
- \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage},
- \l {08-qdoc-commands-linking.html#keyword} {\\keyword},
- \l {08-qdoc-commands-linking.html#l} {\\l},
- \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese},
- \l {10-qdoc-commands-container.html#list} {\\list},
- \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta},
- \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode},
- \l {10-qdoc-commands-container.html#o} {\\o},
- \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode},
- \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit},
- \l {05-qdoc-commands-documentstructuring.html#part} {\\part},
- \l {07-0-qdoc-commands-quoting.html#printline} {\\printline},
- \l {07-0-qdoc-commands-quoting.html#printto} {\\printto},
- \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil},
- \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation},
- \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile},
- \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)},
- \l {10-qdoc-commands-container.html#row} {\\row},
- \l {08-qdoc-commands-linking.html#sa} {\\sa},
- \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1},
- \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2},
- \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3},
- \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4},
- \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline},
- \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto},
- \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil},
- \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet},
- \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#sub} {\\sub},
- \l {04-qdoc-commands-textformatting.html#sup} {\\sup},
- \l {10-qdoc-commands-container.html#table} {\\table},
- \l {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents},
- \l {08-qdoc-commands-linking.html#target} {\\target},
- \l {04-qdoc-commands-textformatting.html#tt} {\\tt},
- \l {04-qdoc-commands-textformatting.html#underline} {\\underline},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\unicode},
- \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
+ \section2 Categories
+ \list
+ \o \l {Text Markup}
+ \o \l {Document Structure}
+ \o \l {Including Code Inline}
+ \o \l {Including External Code}
+ \o \l {Creating Links}
+ \o \l {Including Images}
+ \o \l {Tables and Lists}
+ \o \l {Special Content}
+ \o \l {Miscellaneous}
+ \endlist
- \section1 Categories
+ \section2 Command list
\list
- \o \l {Text Formatting Commands}
- \o \l {Document Structuring Commands}
- \o \l {Verbatim Code Commands}
- \o \l {Quoting External Code Commands}
- \o \l {Linking Commands}
- \o \l {Graphic Commands}
- \o \l {Container Commands}
- \o \l {Document Contents Commands}
- \o \l {Miscellaneous Commands}
+ \o \l {04-qdoc-commands-textmarkup.html#backslash-command} {\\\\}
+ \o \l {04-qdoc-commands-textmarkup.html#a-command} {\\a}
+ \o \l {11-qdoc-commands-specialcontent.html#abstract-command} {\\abstract}
+ \o \l {06-qdoc-commands-includecodeinline.html#badcode-command} {\\badcode}
+ \o \l {04-qdoc-commands-textmarkup.html#bold-command} {\\bold}
+ \o \l {11-qdoc-commands-specialcontent.html#brief-command} {\\brief}
+ \o \l {04-qdoc-commands-textmarkup.html#c-command} {\\c}
+ \o \l {09-qdoc-commands-includingimages.html#caption-command} {\\caption}
+ \o \l {05-qdoc-commands-documentstructure.html#chapter-command} {\\chapter}
+ \o \l {06-qdoc-commands-includecodeinline.html#code-command} {\\code}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#codeline-command} {\\codeline}
+ \o \l {04-qdoc-commands-textmarkup.html#div-command} {\\div} \span {class="newStuff"} {(new)}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#dots-command} {\\dots}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#else-command} {\\else}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#endif-command} {\\endif}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#expire-command} {\\expire}
+ \o \l {11-qdoc-commands-specialcontent.html#footnote-command} {\\footnote}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist}
+ \o \l {10-qdoc-commands-tablesandlists.html#header-command} {\\header}
+ \o \l {04-qdoc-commands-textmarkup.html#i-command} {\\i}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if}
+ \o \l {09-qdoc-commands-includingimages.html#image-command} {\\image}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#include-command} {\\include}
+ \o \l {09-qdoc-commands-includingimages.html#inlineimage-command} {\\inlineimage}
+ \o \l {08-qdoc-commands-creatinglinks.html#keyword-command} {\\keyword}
+ \o \l {08-qdoc-commands-creatinglinks.html#l-command} {\\l}
+ \o \l {11-qdoc-commands-specialcontent.html#legalese-command} {\\legalese}
+ \o \l {10-qdoc-commands-tablesandlists.html#list-command} {\\list}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#meta-command} {\\meta}
+ \o \l {06-qdoc-commands-includecodeinline.html#newcode-command} {\\newcode}
+ \o \l {10-qdoc-commands-tablesandlists.html#o-command} {\\o}
+ \o \l {06-qdoc-commands-includecodeinline.html#oldcode-command} {\\oldcode}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#omit-command} {\\omit}
+ \o \l {05-qdoc-commands-documentstructure.html#part-command} {\\part}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printline-command} {\\printline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printto-command} {\\printto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printuntil-command} {\\printuntil}
+ \o \l {11-qdoc-commands-specialcontent.html#quotation-command} {\\quotation}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefile-command} {\\quotefile}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw-command} {\\raw} \span {class="newStuff"} {(avoid)}
+ \o \l {10-qdoc-commands-tablesandlists.html#row-command} {\\row}
+ \o \l {08-qdoc-commands-creatinglinks.html#sa-command} {\\sa}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionOne-command} {\\section1}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionTwo-command} {\\section2}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionThree-command} {\\section3}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionFour-command} {\\section4}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipline-command} {\\skipline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipto-command} {\\skipto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipuntil-command} {\\skipuntil}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#snippet-command} {\\snippet}
+ \o \l {04-qdoc-commands-textmarkup.html#span-command} {\\span} \span {class="newStuff"} {(new)}
+ \o \l {04-qdoc-commands-textmarkup.html#sub-command} {\\sub}
+ \o \l {04-qdoc-commands-textmarkup.html#sup-command} {\\sup}
+ \o \l {10-qdoc-commands-tablesandlists.html#table-command} {\\table}
+ \o \l {11-qdoc-commands-specialcontent.html#tableofcontents-command} {\\tableofcontents}
+ \o \l {08-qdoc-commands-creatinglinks.html#target-command} {\\target}
+ \o \l {04-qdoc-commands-textmarkup.html#tt-command} {\\tt}
+ \o \l {04-qdoc-commands-textmarkup.html#underline-command} {\\underline}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw-command} {\\unicode}
+ \o \l {11-qdoc-commands-specialcontent.html#warning-command} {\\warning}
\endlist
*/
/*!
- \page 04-qdoc-commands-textformatting.html
+ \page 04-qdoc-commands-textmarkup.html
\contentspage Table of Contents
\previouspage Markup Commands
- \nextpage Document Structuring Commands
+ \nextpage Document Structure
- \title Text Formatting Commands
+ \title Text Markup
The text formatting commands indicate how the regular text in the
documentation is rendered.
- \section1 Alphabetical List
-
- \l {04-qdoc-commands-textformatting.html#backslash} {\\\\},
- \l {04-qdoc-commands-textformatting.html#a} {\\a},
- \l {04-qdoc-commands-textformatting.html#bold} {\\bold},
- \l {04-qdoc-commands-textformatting.html#c} {\\c},
- \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#i} {\\i},
- \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)},
- \l {04-qdoc-commands-textformatting.html#sub} {\\sub},
- \l {04-qdoc-commands-textformatting.html#sup} {\\sup},
- \l {04-qdoc-commands-textformatting.html#tt} {\\tt},
- \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
-
- \o \bold \\\\ \target backslash
- \o \bold {The \\\\ command expands to a single backslash.}
-
- QDoc commands always start with a backslash alone. To
- display an actual backslash in the text you need to type
- two of the kind. If you want to display two backslashes,
- you need to type four, and so forth. For example:
-
- \code
- / *!
- The \\\\ command is useful if you want a
- backslash to appear verbatim, for example,
- writing C:\\windows\\home\\.
- * /
- \endcode
-
- will be rendered as
-
- \quotation
- The \\\\ command is useful if you want a
- backslash to appear verbatim, for example,
- writing C:\\windows\\home\\.
- \endquotation
-
- However, if you want your text to appear in a typewriter
- font as well, you can use the \l {c} {\\c} command instead,
- which accepts and renders the backslash as any other
- character. For example:
-
- \code
- / *!
- The \\c command is useful if you want a
- backslash to appear verbatim, and the word
- that contains it written in a typewriter font,
- like this: \c {C:\windows\home\}.
- * /
- \endcode
-
- will be rendered as
+ \section1 \\a (parameter marker)
+ \target a-command
- \quotation
- The \\c command is useful if you want a
- backslash to appear verbatim, and the word
- that contains it written in a typewriter font,
- like this: \c {C:\windows\home\}.
- \endquotation
+ The \\a command indicates that the next word is a formal parameter name.
- \row
- \o \bold \\a \target a
- \o \bold {The \\a command indicates that the next word
- is a parameter when documenting functions.}
-
- Warnings are emitted when function parameters are
- undocumented or misspelled, so whenever you write
- documentation for functions you should make sure you
- mention all the parameters and precede each of these by the
- \\a command. The parameter is then rendered in italic. For
- example:
+ A warning is emitted when a function parameter is not documented
+ or is misspelled, so when you document a function you should
+ mention each formal parameter name in the function description,
+ preceded by the \\a command. The parameter is then rendered in
+ italics. For example:
\code
/ *!
Constructs a line edit containing the text
- \a contents.
-
- The \a parent parameter is sent to the
- QWidget constructor.
+ \a contents. The \a parent parameter is sent
+ to the QWidget constructor.
* /
QLineEdit::QLineEdit(const QString &contents, QWidget *parent)
@@ -395,31 +257,29 @@
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\bold {QLineEdit::QLineEdit ( const QString &
contents, QWidget *parent )}
Constructs a line edit containing the text \a contents.
-
- The \a parent parameter is sent to the QWidget
- constructor.
-
+ The \a parent parameter is sent to the QWidget constructor.
\endquotation
The \\a command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument. However, a parameter
is always a single word, so braces are rarely
necessary. And for the same reason, parentheses seldom
occur.
- \row
- \o \bold \\c \target c
- \o \bold {The \\c command can be used to render variables,
- user-defined classes and C++ keywords like \c int,
- \c for, etc.}
+ \section1 \\c (code font)
+ \target c-command
+
+ The \\c command is used for rendering variable names, user-defined
+ class names, and C++ keywords, like \c int and \c for in a
+ code font.
The command renders its argument using a typewriter font. For
example:
@@ -432,7 +292,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The \c AnalogClock class provides a clock widget with hour
@@ -441,21 +301,22 @@
\endquotation
The \\c command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
The \\c command accepts the special character \c \ within
its argument, i.e. it renders it as a normal character. So
if you want to use nested commands, you must use the \l
- {tt} {teletype (\\tt)} command instead.
+ {tt-command} {teletype (\\tt)} command instead.
- See also \l {tt} {\\tt} and \l {code-command} {\\code}.
+ See also \l {tt-command} {\\tt} and \l {code-command} {\\code}.
- \row
- \o \bold \\div \span {class="newStuff"} {(new)} \target div
- \o \bold {The \\div command and the corresponding \\enddiv
- command delimit a large or small block of text and qdoc
- commands for which special formatting attributes apply.}
+ \section1 \\div \span {class="newStuff"} {(new)}
+ \target div-command
+
+ The \\div command and the corresponding \\enddiv
+ command delimit a large or small block of text and qdoc
+ commands for which special formatting attributes apply.
An argument must be provided in curly braces, as in the
qdoc comment shown below. The argument is not interpreted
@@ -505,8 +366,8 @@
</sectiondiv>
\endcode
- Your DITA XML publishing program must then recognize the \e
- outputclass attribute value.
+ Your DITA XML publishing program must then recognize the
+ \e {outputclass} attribute value.
\note The \bold {\\div} command can be nested.
@@ -573,7 +434,7 @@
\enddiv
\enddiv
- When generating DITA XML, qdoc outputs the nested \e div commands as:
+ When generating DITA XML, qdoc outputs the nested \e {div} commands as:
\code
<sectiondiv outputclass="indexbox guide">
@@ -618,14 +479,15 @@
\endcode
Your DITA XML publishing program must recognize the values
- of the \e outputclass attribute.
+ of the \e {outputclass} attribute.
- See also \l {span} {\\span}.
+ See also \l {span-command} {\\span}.
- \row
- \o \bold \\span \span {class="newStuff"} {(new)} \target span
- \o \bold {The \\span command is for applying special formatting
- attributes to a small block of text.}
+ \section1 \\span \span {class="newStuff"} {(new)}
+ \target span -command
+
+ The \\span command is for applying special formatting
+ attributes to a small block of text.
Two arguments must be provided, each argument in curly
braces, as shown in the qdoc comment below. The first
@@ -649,7 +511,7 @@
* /
\endcode
- Class \e variableName refers to a clause in your style.css.
+ Class \e {variableName} refers to a clause in your style.css.
\code
.variableName
@@ -659,7 +521,7 @@
}
\endcode
- Using the \e variableName clause shown above, the example is rendered as:
+ Using the \e {variableName} clause shown above, the example is rendered as:
Global variables with complex types:
\list 1
@@ -672,18 +534,20 @@
\note The \bold span command does not cause a new paragraph to
be started.
- See also \l {div} {\\div}.
+ See also \l {div-command} {\\div}.
- \row
- \o \bold \\tt \target tt
- \o \bold {The \\tt command can be used to render variables,
- user-defined classes and C++ keywords like \c int, \c
- for, etc.}
+ \section1 \\tt
+ \target tt-command
+
+ The \\tt command can be used to render variables,
+ user-defined classes and C++ keywords like \c int, \c
+ for, etc.
- The \\tt command behaves just like the \l {c} {\\c} command,
- except that \\tt parses QDoc commands (like \l {i} {\\i}, \l
- {bold} {\\bold} and \l {underline} {\\underline}) contained
- within its argument.
+ The \\tt command behaves just like the \l {c-command} {\\c}
+ command, except that \\tt parses QDoc commands (like \l
+ {i-command} {\\i}, \l {bold-command} {\\bold} and \l
+ {underline-command} {\\underline}) contained within its
+ argument.
The command renders its argument using a monospace
font. For example:
@@ -693,29 +557,30 @@
After \c setupUi() populates the main container with
child widgets it scans the main container's list of
slots for names with the form
- \tt{on_\i{objectName}_\i{signalName}().}
+ \tt{on_\e{objectName}_\e{signalName}().}
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
After \c setupUi() populates the main container with
child widgets it scans the main container's list of
slots for names with the form
- \tt{on_\i{objectName}_\i{signalName}().}
+ \tt{on_\e{objectName}_\e{signalName}().}
\endquotation
The \\tt command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- See also \l {c} {\\c}.
+ See also \l {c-command} {\\c}.
- \row
- \o \bold \\bold \target bold
- \o \bold {The \\bold command renders its argument using
- a bold font.}
+ \section1 \\bold
+ \target bold-command
+
+ The \\bold command renders its argument using
+ a bold font.
For example:
@@ -726,20 +591,20 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
This is regular text; \bold {this text is rendered using
the \\bold command}.
\endquotation
- The command follows the same conventions as the \l {i} {\\i}
+ The command follows the same conventions as the \l {i-command} {\\i}
command for \l {argument} {punctuation, parentheses and use
of braces} for the argument.
- \row
- \o \bold \\i \target i
- \o \bold {The \\i command renders its argument in italic.}
+ \section1 \\i
+ \target i-command
+ The \\i command renders its argument in italic.
\warning This is preliminary functionality. For
more information, see the \l
@@ -756,10 +621,10 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
- Here, we render \i {a few words} in italic.
+ Here, we render \e {a few words} in italic.
\endquotation
If you want to use other QDoc commands within an argument
@@ -774,11 +639,11 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
An argument can sometimes contain whitespaces,
- for example: \i QPushButton(tr("A Brand New Button"))
+ for example: \e QPushButton(tr("A Brand New Button"))
\endquotation
Finally, trailing punctuation is not included in an
@@ -795,7 +660,7 @@
<tr valign="top" bgcolor="#d0d0d0">
<td>1</td>
- <td>A variation of a command button is a \i menu
+ <td>A variation of a command button is a \e menu
button.</td>
<td>A variation of a command button is a <i>menu</i>
button.</td>
@@ -804,7 +669,7 @@
<tr valign="top" bgcolor="#c0c0c0">
<td>2</td>
<td>The QPushButton widget provides a
- \i {command button}.</td>
+ \e {command button}.</td>
<td>The QPushButton widget provides a
<i>command button</i>.</td>
</tr>
@@ -812,20 +677,20 @@
<tr valign="top" bgcolor="#d0d0d0">
<td>3</td>
<td>Another class of buttons are option buttons
- \i (see QRadioButton).</td>
+ \e (see QRadioButton).</td>
<td>Another class of buttons are option buttons
<i> (see QRadioButton)</i>.</td>
</tr>
<tr valign="top" bgcolor="#c0c0c0">
<td>4</td>
- <td>A push button emits the signal \i clicked().</td>
+ <td>A push button emits the signal \e clicked().</td>
<td>A push button emits the signal <i>clicked</i>().</td>
</tr>
<tr valign="top" bgcolor="#d0d0d0">
<td>5</td>
- <td>The \i QPushButton's checked property is
+ <td>The \e QPushButton's checked property is
false by default.</td>
<td>The <i>QPushButton</i>'s checked property is
false by default.</td>
@@ -834,10 +699,11 @@
</table>
\endraw
- \row
- \o \bold \\sub \target sub
- \o \bold {The \\sub command renders its argument lower
- than the baseline of the regular text, using a smaller font.}
+ \section1 \\sub
+ \target sub-command
+
+ The \\sub command renders its argument lower
+ than the baseline of the regular text, using a smaller font.
For example:
@@ -852,7 +718,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Definition (Range): Consider the sequence
@@ -864,13 +730,14 @@
\endquotation
The \\sub command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- \row
- \o \bold \\sup \target sup
- \o \bold {The \\sup command renders its argument higher than
- the baseline of the regular text, using a smaller font.}
+ \section1 \\sup
+ \target sup-command
+
+ The \\sup command renders its argument higher than
+ the baseline of the regular text, using a smaller font.
For example:
@@ -884,23 +751,24 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The series
1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
- is called the \i {geometric series}.
+ is called the \e {geometric series}.
\endquotation
The \\sup command follows the same conventions as the \l
- {i} {\\i} command for \l {argument} {punctuation, parentheses
+ {i-command} {\\i} command for \l {argument} {punctuation, parentheses
and use of braces} for the argument.
- \row
- \o \bold \\underline \target underline
- \o \bold {The \\underline command renders its argument underlined.}
+ \section1 \\underline
+ \target underline-command
+
+ The \\underline command renders its argument underlined.
For example:
@@ -912,7 +780,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The \underline {F}ile menu gives the users the possibility
@@ -921,17 +789,67 @@
\endquotation
The \\underline command follows the same conventions as the
- \l {i} {\\i} command for \l {argument} {punctuation,
- parentheses and use of braces} for the argument. \endtable
+ \l {i-command} {\\i} command for \l {argument} {punctuation,
+ parentheses and use of braces} for the argument.
+
+ \section1 \\\\ (double backslash)
+ \target backslash-command
+
+ The \\\\ command expands to a single backslash.
+
+ QDoc commands always start with a backslash alone. To
+ display an actual backslash in the text you need to type
+ two of the kind. If you want to display two backslashes,
+ you need to type four, and so forth. For example:
+
+ \code
+ / *!
+ The \\\\ command is useful if you want a
+ backslash to appear verbatim, for example,
+ writing C:\\windows\\home\\.
+ * /
+ \endcode
+
+ QDoc renders this as:
+
+ \quotation
+ The \\\\ command is useful if you want a
+ backslash to appear verbatim, for example,
+ writing C:\\windows\\home\\.
+ \endquotation
+
+ However, if you want your text to appear in a typewriter
+ font as well, you can use the \l {c-command} {\\c} command instead,
+ which accepts and renders the backslash as any other
+ character. For example:
+
+ \code
+ / *!
+ The \\c command is useful if you want a
+ backslash to appear verbatim, and the word
+ that contains it written in a typewriter font,
+ like this: \c {C:\windows\home\}.
+ * /
+ \endcode
+
+ QDoc renders this as:
+
+ \quotation
+ The \\c command is useful if you want a
+ backslash to appear verbatim, and the word
+ that contains it written in a typewriter font,
+ like this: \c {C:\windows\home\}.
+ \endquotation
+
*/
/*!
- \page 05-qdoc-commands-documentstructuring.html
- \previouspage Text Formatting Commands
+ \page 05-qdoc-commands-documentstructure.html
+ \previouspage Text Markup
\contentspage Table of Contents
- \nextpage Verbatim Code Commands
+ \nextpage Including Code Inline
- \title Document Structuring Commands
+ \title Document Structure
The document structuring commands divide the documentation into
sections. In total, there are six levels of sections in QDoc: \c
@@ -940,26 +858,11 @@
traditional section, subsection, subsubsection and
subsubsubsection.
- \section1 Alphabetical List
-
- \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter},
- \l {05-qdoc-commands-documentstructuring.html#part} {\\part},
- \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1},
- \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2},
- \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3},
- \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\part
+ \target part-command
- \row
- \o \bold \\part \target part
- \o \bold {The \\part command is intended for use in
- larger documents, and divides the document into parts.}
+ The \\part command is intended for use in
+ larger documents, and divides the document into parts.
In general a document structuring command considers
everything that follows it until the first line break as
@@ -995,7 +898,7 @@
section unit, for example from \c part to \c section1, is
not allowed.
- You can \i begin with either of the three: \c part, \c
+ You can \e begin with either of the three: \c part, \c
chapter or \c section1. For example:
@@ -1056,7 +959,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -1123,91 +1026,89 @@
generated table of contents appears in the upper
righthand corner of the page.
- \row
- \o \bold \\chapter \target chapter
- \o \bold {The \\chapter command is intended for use in
- larger documents, and divides the document into chapters.}
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ \section1 \\chapter
+ \target chapter-command
+
+ The \\chapter command is intended for use in
+ larger documents, and divides the document into chapters.
- \row
- \o \bold \\section1 \target sectionOne
- \o \bold {The \\section1 command starts a new section.}
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
- \row
- \o \bold \\section2 \target sectionTwo
- \o \bold {The \\section2 command starts a new section.}
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ \section1 \\section1
+ \target sectionOne-command
- \row
- \o \bold \\section3 \target sectionThree
- \o \bold {The \\section3 command starts a new section.}
+ The \\section1 command starts a new section.
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
- \row
- \o \bold \\section4 \target sectionFour
- \o \bold {The \\section4 command starts a new section.}
+ \section1 \\section2
+ \target sectionTwo-command
- See \l{part} {\\part} for an explanation of the various
- section units, command argument and rendering.
+ The \\section2 command starts a new section.
+
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
+
+
+ \section1 \\section3
+ \target sectionThree-command
+
+ The \\section3 command starts a new section.
+
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
+
+
+ \section1 \\section4
+ \target sectionFour-command
+
+ The \\section4 command starts a new section.
+
+ See \l{part} {\\part} for an explanation of the various
+ section units, command argument and rendering.
- \endtable
*/
/*!
- \page 06-qdoc-commands-verbatimcode.html
- \previouspage Document Structuring Commands
+ \page 06-qdoc-commands-includecodeinline.html
+ \previouspage Document Structure
\contentspage Table of Contents
- \nextpage Quoting External Code Commands
+ \nextpage Including External Code
- \title Verbatim Code Commands
+ \title Including Code Inline
The following commands are used to render verbatim code within the
documentation. The code is rendered on a new line, using a
typewriter font and the standard indentation.
\bold{Note:} Although all of these commands can be used to present
- C++ code, the \l{07-0-qdoc-commands-quoting.html#snippet} {\\snippet}
- and \l{07-0-qdoc-commands-quoting.html#codeline} {\\codeline} commands
- should be used in preference to
- the others when presenting valid code. This allows auxilliary tools
- for Qt language bindings to substitute the relevant code snippets in
+ C++ code, the
+ \l{07-0-qdoc-commands-includingexternalcode.html#snippet-command}
+ {\\snippet} and
+ \l{07-0-qdoc-commands-includingexternalcode.html#codeline-command}
+ {\\codeline} commands should be used in preference to the others
+ when presenting valid code. This allows auxilliary tools for Qt
+ language bindings to substitute the relevant code snippets in
place of the C++ ones.
- \section1 Alphabetical List
-
- \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode},
- \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code},
- \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode},
- \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode}
-
- \section1 Command Descriptions
+ \section1 \\code
+ \target code-command
- \table
- \header
- \o Command
- \o Description
+ The \\code command and the corresponding
+ \\endcode command delimit a piece of verbatim code.
- \row
- \o \bold \\code \target code-command
- \o \bold {The \\code command and the corresponding
- \\endcode command delimit a piece of verbatim code.}
-
- Whereas the \l {c} {\\c} command can be used for short code
+ Whereas the \l {c-command} {\\c} command can be used for short code
fragments within a sentence, the \\code command is for
longer code snippets and renders the code verbatim in a
separate paragraph using a typewriter font and the standard
indentation.
- When processing any of the \\code, \l {badcode} {\\badcode},
- \l {newcode} {\\newcode} and \l {oldcode} {\\oldcode}
+ When processing any of the \\code, \l {badcode-command} {\\badcode},
+ \l {newcode-command} {\\newcode} and \l {oldcode-command} {\\oldcode}
commands, QDoc basically removes all indentation that is
common for the verbatim code blocks within a \c{/}\c{*!} ...
\c{*}\c{/} comment before it adds the standard
@@ -1233,7 +1134,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\code
#include <QApplication>
@@ -1252,19 +1153,21 @@
You need to type the code manually between the \\code and
\\endcode commands. If you want to include code snippets
from a particular file, use the \l
- {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile}
+ {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
command instead.
- See also \l {c} {\\c}, \l
- {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
- \l {badcode} {\\badcode}, \l {newcode} {\\newcode} and \l
- {oldcode} {\\oldcode}.
+ See also \l {c-command} {\\c}, \l
+ {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile},
+ \l {badcode-command} {\\badcode}, \l {newcode-command} {\\newcode} and \l
+ {oldcode-command} {\\oldcode}.
- \row
- \o \bold \\badcode \target badcode
- \o \bold {The \\badcode command and the corresponding
- \\endcode command delimit a piece of code that doesn't
- compile or is wrong for some other reason.}
+
+ \section1 \\badcode
+ \target badcode-command
+
+ The \\badcode command and the corresponding
+ \\endcode command delimit a piece of code that doesn't
+ compile or is wrong for some other reason.
The \\badcode command is similar the \l {code-command} {\\code}
command, but renders the code using a grey font instead of
@@ -1292,7 +1195,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The statement below is rendered using the
@@ -1314,23 +1217,25 @@
\\badcode... \\endcode, and the special character '\\' is
accepted and rendered like the rest of the code.
- See also \l {code-command} {\\code}, \l {newcode} {\\newcode} and \l
- {oldcode} {\\oldcode}.
+ See also \l {code-command} {\\code}, \l {newcode-command} {\\newcode} and \l
+ {oldcode-command} {\\oldcode}.
- \row
- \o \bold \\newcode \target newcode
- \o \bold {The \\newcode command, and the associated \\oldcode
- and \\endcode commands, indicate how to port a piece of
- code to a new version of an API.}
+
+ \section1 \\newcode
+ \target newcode-command
+
+ The \\newcode command, and the associated \\oldcode
+ and \\endcode commands, indicate how to port a piece of
+ code to a new version of an API.
The \\newcode command, and its companion the \\oldcode
command, is a convenience combination of the \l
- {code-command} {\\code} and \l {badcode} {\\badcode} commands: The
+ {code-command} {\\code} and \l {badcode-command} {\\badcode} commands: The
combination provides a text relating the two code snippets
to each other. The command requires a preceding \\oldcode
statement.
- Like the \l {code-command} {\\code} and \l {badcode} {\\badcode}
+ Like the \l {code-command} {\\code} and \l {badcode-command} {\\badcode}
commands, the \\newcode command renders its code on a new
line in the documentation using a typewriter font and the
standard indentation. For example:
@@ -1365,23 +1270,24 @@
\\oldcode ... \\endcode, and the '\\' character doesn't need
to be escaped.
- \row
- \o \bold \\oldcode \target oldcode
- \o \bold {The \\oldcode command requires a corresponding
- \\newcode statement; otherwise QDoc fails to parse the command
- and emits a warning.}
- See also \l {newcode} {\\newcode} and \l {badcode} {\\badcode}.
- \endtable
+ \section1 \\oldcode
+ \target oldcode-command
+
+ The \\oldcode command requires a corresponding
+ \\newcode statement; otherwise QDoc fails to parse the command
+ and emits a warning.
+
+ See also \l {newcode-command} {\\newcode} and \l {badcode-command} {\\badcode}.
*/
/*!
- \page 07-0-qdoc-commands-quoting.html
- \previouspage Verbatim Code Commands
+ \page 07-0-qdoc-commands-includingexternalcode.html
+ \previouspage Including Code Inline
\contentspage Table of Contents
- \nextpage Linking Commands
+ \nextpage Creating Links
- \title Quoting External Code Commands
+ \title Including External Code
The following commands enable quoting from files in the
documentation: You can make QDoc include the complete contents of
@@ -1396,31 +1302,11 @@
for Qt language bindings to substitute the relevant code snippets in
place of the C++ ones.
- \section1 Alphabetical List
+ \section1 \\quotefile
+ \target quotefile-command
- \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
- \l {07-0-qdoc-commands-quoting.html#dots} {\\dots},
- \l {07-0-qdoc-commands-quoting.html#printline} {\\printline},
- \l {07-0-qdoc-commands-quoting.html#printto} {\\printto},
- \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil},
- \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile},
- \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile},
- \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline},
- \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto},
- \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil},
- \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\quotefile \target quotefile-command
- \o \bold {The \\quotefile command expands to the complete
- contents of the file given as argument.}
+ The \\quotefile command expands to the complete
+ contents of the file given as argument.
The command considers the rest of the line as part of its
argument, make sure to follow the file name with a line
@@ -1443,7 +1329,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
This is a simple "Hello world" example:
@@ -1454,17 +1340,18 @@
application up and running.
\endquotation
- \warning If you use the \l {QDoc
- Compatibility} {compat.qdocconf} file this command is called
- \\include.
+ \warning If you use the \l {Compatibility Issues}
+ {compat.qdocconf} file this command is called \\include.
See also \l {quotefromfile-command} {\\quotefromfile} and
\l {code-command} {\\code}.
- \row
- \o \bold \\quotefromfile \target quotefromfile-command
- \o \bold {The \\quotefromfile command opens the file
- given as argument for quoting.}
+
+ \section1 \\quotefromfile
+ \target quotefromfile-command
+
+ The \\quotefromfile command opens the file
+ given as argument for quoting.
The command considers the rest of the line as part of its
argument, make sure to follow the file name with a line
@@ -1472,9 +1359,9 @@
The command is intended for use when quoting parts from
file with the walkthrough commands: \l
- {printline} {\\printline}, \l {printto} {\\printto}, \l
- {printuntil} {\\printuntil}, \l {skipline} {\\skipline}, \l
- {skipto} {\\skipto}, \l {skipuntil} {\\skipuntil}. This
+ {printline-command} {\\printline}, \l {printto-command} {\\printto}, \l
+ {printuntil-command} {\\printuntil}, \l {skipline-command} {\\skipline}, \l
+ {skipto-command} {\\skipto}, \l {skipuntil-command} {\\skipuntil}. This
enables you to quote specific portions of a file. For
example:
@@ -1501,7 +1388,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within
@@ -1538,11 +1425,13 @@
See also \l {quotefile-command} {\\quotefile}, \l
{code-command} {\\code} and \l {dots} {\\dots}.
- \row
- \o \bold \\printline \target printline
- \o \bold {The \\printline command expands to the line
- from the current position to the next non-blank line of
- the current souce file.}
+
+ \section1 \\printline
+ \target printline-command
+
+ The \\printline command expands to the line
+ from the current position to the next non-blank line of
+ the current souce file.
To ensure that the documentation always is synchronized
with the source file, a substring of the line must be
@@ -1583,7 +1472,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
There has to be exactly one QApplication object
@@ -1616,7 +1505,7 @@
QDoc reads the file sequentially. To move the current
position forward you can use either of the \l
- {skipline} {\\skip...} commands. To move the current
+ {skipline-command} {\\skip...} commands. To move the current
position backward, you can use the \l
{quotefromfile-command} {\\quotefromfile} command again.
@@ -1642,7 +1531,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\quotefromfile widgets/scribble/mainwindow.cpp
@@ -1670,20 +1559,22 @@
regular expression cannot be located, i.e. if the source
code has changed.
- See also \l {printto} {\\printto} and \l
- {printuntil} {\\printuntil}.
+ See also \l {printto-command} {\\printto} and \l
+ {printuntil-command} {\\printuntil}.
- \row
- \o \bold \\printto \target printto
- \o \bold {The \\printto command expands to all the lines
- from the current position up to and \i excluding the
- next line containing a given substring.}
+
+ \section1 \\printto
+ \target printto-command
+
+ The \\printto command expands to all the lines
+ from the current position up to and \e excluding the
+ next line containing a given substring.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
{file} {positioning} and \l {substring} {argument} as the \l
- {printline} {\\printline} command.
+ {printline-command} {\\printline} command.
The lines from the source file are rendered in a separate
paragraph, using a typewriter font and the standard
@@ -1704,7 +1595,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within the
@@ -1720,20 +1611,22 @@
(\l {Example File} {The complete example file...})
- See also \l {printline} {\\printline} and \l
- {printuntil} {\\printuntil}.
+ See also \l {printline-command} {\\printline} and \l
+ {printuntil-command} {\\printuntil}.
- \row
- \o \bold \\printuntil \target printuntil
- \o \bold {The \\printuntil command expands to all the lines
- from the current position up to and \i including the next line
- containing a given substring.}
+
+ \section1 \\printuntil
+ \target printuntil-command
+
+ The \\printuntil command expands to all the lines
+ from the current position up to and \e including the next line
+ containing a given substring.
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
{file} {positioning} and \l {substring} {argument} as the \l
- {printline} {\\printline} command.
+ {printline-command} {\\printline} command.
The lines from the source file are rendered in a separate
paragraph, using a typewriter font and the standard
@@ -1756,7 +1649,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within the
@@ -1775,13 +1668,15 @@
(\l {Example File} {The complete example file...})
- See also \l {printline} {\\printline} and \l
- {printto} {\\printto}.
+ See also \l {printline-command} {\\printline} and \l
+ {printto-command} {\\printto}.
- \row
- \o \bold \\skipline \target skipline
- \o \bold {The \\skipline command ignores the next non-blank
- line in the current source file.}
+
+ \section1 \\skipline
+ \target skipline-command
+
+ The \\skipline command ignores the next non-blank
+ line in the current source file.
Doc reads the file sequentially, and the \\skipline command
is used to move the current position (omitting a line of
@@ -1791,7 +1686,7 @@
The command considers the rest of the line as part of its
argument, make sure to follow the substring with a line
break. The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline} {\\printline}
+ {substring} {argument} as the \l {printline-command} {\\printline}
command, and it is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command. For example:
@@ -1811,7 +1706,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\l
@@ -1831,14 +1726,16 @@
(\l {Example File} {The complete example file...})
- See also \l {skipto} {\\skipto}, \l
- {skipuntil} {\\skipuntil} and \l {dots} {\\dots}.
+ See also \l {skipto-command} {\\skipto}, \l
+ {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
- \row
- \o \bold \\skipto \target skipto
- \o \bold {The \\skipto command ignores all the lines from the
- current position up to and \i excluding the next line
- containing a given substring.}
+
+ \section1 \\skipto
+ \target skipto-command
+
+ The \\skipto command ignores all the lines from the
+ current position up to and \e excluding the next line
+ containing a given substring.
QDoc reads the file sequentially, and the \\skipto command
is used to move the current position (omitting one or
@@ -1850,7 +1747,7 @@
break.
The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline} {\\printline}
+ {substring} {argument} as the \l {printline-command} {\\printline}
command, and it is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command. For example:
@@ -1871,7 +1768,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The whole application is contained within
@@ -1889,14 +1786,16 @@
(\l {Example File} {The complete example file...})
- See also \l {skipline} {\\skipline}, \l
- {skipuntil} {\\skipuntil} and \l {dots} {\\dots}.
+ See also \l {skipline-command} {\\skipline}, \l
+ {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}.
- \row
- \o \bold \\skipuntil \target skipuntil
- \o \bold {The \\skipuntil command ignores all the lines from
- the current position up to and \i including the next line
- containing a given substring.}
+
+ \section1 \\skipuntil
+ \target skipuntil-command
+
+ The \\skipuntil command ignores all the lines from
+ the current position up to and \e including the next line
+ containing a given substring.
QDoc reads the file sequentially, and the \\skipuntil
command is used to move the current position (omitting one
@@ -1908,7 +1807,7 @@
break.
The command also follows the same conventions for \l
- {substring} {argument} as the \l {printline} {\\printline}
+ {substring} {argument} as the \l {printline-command} {\\printline}
command, and it is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command. For example:
@@ -1928,7 +1827,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The first thing we did in the \c main() function was to
@@ -1946,13 +1845,15 @@
(\l {Example File} {The complete example file...})
- See also \l {skipline} {\\skipline}, \l {skipto} {\\skipto}
+ See also \l {skipline-command} {\\skipline}, \l {skipto-command} {\\skipto}
and \l {dots} {\\dots}.
- \row
- \o \bold \\dots \target dots
- \o \bold {The \\dots command indicates that parts of the
- source file have been omitted when quoting a file.}
+
+ \section1 \\dots
+ \target dots-command
+
+ The \\dots command indicates that parts of the
+ source file have been omitted when quoting a file.
The command is used in conjunction with the \l
{quotefromfile-command} {\\quotefromfile} command, and should be
@@ -1970,7 +1871,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotefromfile examples/main.cpp
\skipto main
@@ -1995,7 +1896,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\dots 0
\dots
@@ -2003,14 +1904,17 @@
\dots 12
\dots 16
- See also \l {skipline} {\\skipline}, \l
- {skipto} {\\skipto} and \l {skipuntil} {\\skipuntil}.
+ See also \l {skipline-command} {\\skipline}, \l
+ {skipto-command} {\\skipto} and \l {skipuntil-command}
+ {\\skipuntil}.
+
+
+ \section1 \\snippet
+ \target snippet-command
+
+ The \\snippet command causes a code snippet to be included
+ verbatim as preformatted text, which may be syntax highlighted.
- \row
- \o \bold \\snippet \target snippet
- \o \bold {The \\snippet command causes a code snippet to be included
- verbatim as preformatted text, which may be syntax highlighted.}
-
Each code snippet are referenced by the file that holds it and by
a unique identifier for that file. Snippet files are typically
stored in a \c{snippets} directory inside the documentation
@@ -2039,17 +1943,19 @@
//! [Adding a resource]
\endcode
\dots
- \row
- \o \bold \\codeline \target codeline
- \o \bold{The \\codeline command inserts a blank line of preformatted
- text. It is used to insert gaps between snippets without closing
- the current preformatted text area and opening a new one.}
- \endtable
+
+ \section1 \\codeline
+ \target codeline-command
+
+ The \\codeline command inserts a blank line of preformatted
+ text. It is used to insert gaps between snippets without closing
+ the current preformatted text area and opening a new one.
+
*/
/*!
\page 07-1-example.html
- \previouspage Quoting External Code Commands
+ \previouspage Including External Code
\contentspage Table of Contents
\title Example File
@@ -2058,35 +1964,22 @@
*/
/*!
- \page 08-qdoc-commands-linking.html
- \previouspage Quoting External Code Commands
+ \page 08-qdoc-commands-creatinglinks.html
+ \previouspage Including External Code
\contentspage Table of Contents
- \nextpage Graphic Commands
+ \nextpage Including Images
- \title Linking Commands
+ \title Creating Links
The linking commands make it possible to create hyperlinks to
classes, functions, header files and examples. They also make it
possible to link to targets within a document, as well as to other
documents and URLs.
- \section1 Alphabetical List
-
- \l {08-qdoc-commands-linking.html#keyword} {\\keyword},
- \l {08-qdoc-commands-linking.html#l} {\\l},
- \l {08-qdoc-commands-linking.html#sa} {\\sa},
- \l {08-qdoc-commands-linking.html#target} {\\target}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\l
+ \target l-command
- \row
- \o \bold \\l \target l
- \o \bold {The \\l command is used to create hyperlinks. }
+ The \\l command is used to create hyperlinks.
The command's general syntax is
@@ -2103,7 +1996,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Read the \l {http://qt.nokia.com/doc/4.0/}
@@ -2148,25 +2041,44 @@
\endcode
For the one-parameter version the braces can often
- be omitted. See the \l {i} {\\i} command for the \l
+ be omitted. See the \l {i-command} {\\i} command for the \l
{argument} {argument conventions}.
The \\l command supports several kinds of links:
\list
- \o \c {\l QWidget} - a defined \l {class-command} {\\class}
- \o \c {\l QWidget::sizeHint()} - a defined member
- function (\l {fn} {\\fn})
- \o \c {\l <QtGlobal>} - a defined \l {headerfile} {\\headerfile}
- \o \c {\l widgets/wiggly} - a defined
- \l {example-command} {\\example}
- \o \c {\l {QWidget Class Reference}} - a defined \l {title-command} {\\title}
- \o \c {\l {Introduction}}- a defined \l{part} {\\part},
- \l{chapter} {\\chapter} or \l {sectionOne} {\\section...}
- \o \c {\l fontmatching} - a defined \l {target} {\\target}
- \o \c {\l {Shared Classes}} - a defined \l {keyword} {\\keyword}
- \o \c {\l network.html} - a defined \l {page} {\\page}
- \o \c {\l http://www.trolltech.com/} - a URL
+
+ \o \c {\l QWidget} - The name of a class documented with
+ the \l {class-command} {\\class} command.
+
+ \o \c {\l QWidget::sizeHint()} - The name of a documented
+ member function (documented with or without the \l
+ {fn-command} {\\fn} command).
+
+ \o \c {\l <QtGlobal>} - The subject of a \l
+ {headerfile-command} {\\headerfile} command.
+
+ \o \c {\l widgets/wiggly} - The relative path used in an \l
+ {example-command} {\\example} command.
+
+ \o \c {\l {QWidget Class Reference}} - The title used in a
+ \l {title-command} {\\title} command.
+
+ \o \c {\l {Introduction to QDoc}}- The text from one of the
+ \l{part-command} {\\part}, \l{chapter} {\\chapter}
+ or \l {sectionOne-command} {\\section} commands.
+
+ \o \c {\l fontmatching} - The argument of a \l
+ {target-command} {\\target} command.
+
+ \o \c {\l {Shared Classes}} - A keyword used in a \l
+ {keyword-command} {\\keyword} command.
+
+ \o \c {\l network.html} - The file name used in a \l
+ {page-command} {\\page} command.
+
+ \o \c {\l http://www.trolltech.com/} - A URL.
+
\endlist
QDoc also tries to make a link out of any words that don't
@@ -2182,14 +2094,16 @@
\o \c {\l {QWidget::} {sizeHint()}}
\endlist
- See also \l {sa} {\\sa}, \l {target} {\\target} and \l
- {keyword} {\\keyword}.
+ See also \l {sa-command} {\\sa}, \l {target-command} {\\target}
+ and \l {keyword-command} {\\keyword}.
- \row
- \o \bold \\sa \target sa
- \o \bold {The \\sa command defines a list of links that will
- be rendered in a separate "See also" section at the bottom
- of the documentation.}
+
+ \section1 \\sa
+ \target sa-command
+
+ The \\sa command defines a list of links that will
+ be rendered in a separate "See also" section at the bottom
+ of the documentation.
The command takes a comma-separated list of links as its
argument. If the line ends with a comma, you can continue
@@ -2217,7 +2131,7 @@
\endlist
The \\sa command supports the same kind
- of links as the \l {l} {\\l} command. For example:
+ of links as the \l {l-command} {\\l} command. For example:
\code
/ *!
@@ -2232,27 +2146,29 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\bold {void QWidget::addActions ( QList<QAction*>
- \i actions )}
+ \e actions )}
- Appends the actions \i actions to this widget's
+ Appends the actions \e actions to this widget's
list of actions.
See also \l {QWidget::removeAction()} {removeAction()},
\l QMenu, and \l {QWidget::addAction()} {addAction()}.
\endquotation
- See also \l {l} {\\l}, \l {target} {\\target} and \l
- {keyword} {\\keyword}.
+ See also \l {l-command} {\\l}, \l {target-command} {\\target} and \l
+ {keyword-command} {\\keyword}.
- \row
- \o \bold \\target \target target
- \o \bold {The \\target command defines an explicit point in the
- documentation that you can later link to using the \l {l} {\\l}
- and \l {sa} {\\sa} commands.}
+
+ \section1 \\target
+ \target target-command
+
+ The \\target command defines an explicit point in the
+ documentation that you can later link to using the \l {l-command} {\\l}
+ and \l {sa-command} {\\sa} commands.
The command considers the rest of the line as part of its
argument, make sure to follow the target name with a line
@@ -2292,21 +2208,23 @@
If the target name does't contain any spaces, the brackets can
be omitted as well.
- See also \l {l} {\\l}, \l {sa} {\\sa} and \l
- {keyword} {\\keyword}.
+ See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
+ {keyword-command} {\\keyword}.
- \row
- \o \bold \\keyword \target keyword
- \o \bold {The \\keyword command defines an explicit point in the
- documentation that you can later link to using the \l {l} {\\l}
- and \l {sa} {\\sa} commands.}
+
+ \section1 \\keyword
+ \target keyword-command
+
+ The \\keyword command defines an explicit point in the
+ documentation that you can later link to using the \l {l-command} {\\l}
+ and \l {sa-command} {\\sa} commands.
Keywords must be unique within the entire set of
documentation processed in on QDoc run. The command
considers the rest of the line as part of its argument,
make sure to follow the keyword with a line break.
- The \\keyword command is similar to \l {target} {\\target},
+ The \\keyword command is similar to \l {target-command} {\\target},
but stronger. A keyword can be referenced from anywhere
using a simple syntax. For example:
@@ -2330,7 +2248,7 @@
* /
\endcode
- can be referenced like this
+ The location of the keyword can be linked to like this:
\code
/ *!
@@ -2339,7 +2257,7 @@
* /
\endcode
- which will be rendered as
+ QDoc renders this as:
\quotation
When a string is surrounded by slashes, it's
@@ -2349,40 +2267,28 @@
If the keyword does't contain any spaces, the brackets can
be omitted as well.
- See also \l {l} {\\l}, \l {sa} {\\sa} and \l
- {target} {\\target}.
- \endtable
+ See also \l {l-command} {\\l}, \l {sa-command} {\\sa} and \l
+ {target-command} {\\target}.
+
*/
/*!
- \page 09-qdoc-commands-graphic.html
- \previouspage Linking Commands
+ \page 09-qdoc-commands-includingimages.html
+ \previouspage Creating Links
\contentspage Table of Contents
- \nextpage Container Commands
+ \nextpage Tables and Lists
- \title Graphic Commands
+ \title Including Images
The graphic commands makes it possible to include images in the
documentation. The images can be rendered as separate paragraphs,
or within running text.
- \section1 Alphabetical List
-
- \l {09-qdoc-commands-graphic.html#caption} {\\caption},
- \l {09-qdoc-commands-graphic.html#image} {\\image},
- \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
+ \section1 \\image
+ \target image-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\image \target image
- \o \bold {The \\image command expands to the image specified by its
- argument, and renders it centered as a separate paragraph.}
+ The \\image command expands to the image specified by its
+ argument, and renders it centered as a separate paragraph.
The \\image command replaces the old \\img command. For more
information, see the \l
@@ -2416,7 +2322,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Qt by Trolltech is a C++ toolkit for cross-platform GUI
@@ -2430,13 +2336,15 @@
\endquotation
See also \l {inlineimage-command} {\\inlineimage} and \l
- {caption} {\\caption}.
+ {caption-command} {\\caption}.
- \row
- \o \bold \\inlineimage \target inlineimage-command
- \o \bold {The \\inlineimage command expands to the image
- specified by its argument; the image is rendered inline
- with the rest of the text.}
+
+ \section1 \\inlineimage
+ \target inlineimage-command
+
+ The \\inlineimage command expands to the image
+ specified by its argument; the image is rendered inline
+ with the rest of the text.
The command takes two arguments. The first is the name of
the image file. The second argument is optional and is a
@@ -2458,7 +2366,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\list 1
\o \inlineimage happy.gif Oh so happy!
@@ -2484,7 +2392,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2526,7 +2434,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\inlineimage training.jpg Training by Trolltech
@@ -2538,58 +2446,44 @@
to derive maximum benefit from the course.
\endquotation
- See also \l {image} {\\image} and \l {caption} {\\caption}.
+ See also \l {image-command} {\\image} and \l {caption-command} {\\caption}.
- \row
- \o \bold \\caption \target caption
- \o \bold {The \\caption command provides a caption for an image.}
+
+ \section1 \\caption
+ \target caption-command
+
+ The \\caption command provides a caption for an image.
The command follows the same conventions for parentheses and use
- of braces for its \l argument as the \l {i} {\\i} command.
+ of braces for its \l argument as the \l {i-command} {\\i} command.
\warning This is preliminary functionality. The
command is not fully implemented.
- See also \l {image} {\\image} and \l
+ See also \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage}
- \endtable
+
*/
/*!
- \page 10-qdoc-commands-container.html
- \previouspage Graphic Commands
+ \page 10-qdoc-commands-tablesandlists.html
+ \previouspage Including Images
\contentspage Table of Contents
- \nextpage Document Contents Commands
+ \nextpage Special Content
- \title Container Commands
+ \title Tables and Lists
The container commands create tables and lists with associated
items and contents. A list is rendered left aligned as a separate
paragraph. A table is rendered centered as a separate paragraph,
and its width depends on its content.
- \section1 Alphabetical List
-
- \l {10-qdoc-commands-container.html#header} {\\header},
- \l {10-qdoc-commands-container.html#list} {\\list},
- \l {10-qdoc-commands-container.html#o} {\\o},
- \l {10-qdoc-commands-container.html#omitvalue-command} {\\omitvalue},
- \l {10-qdoc-commands-container.html#row} {\\row},
- \l {10-qdoc-commands-container.html#table} {\\table},
- \l {10-qdoc-commands-container.html#value-command} {\\value}
+ \section1 \\table
+ \target table-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\table \target table
- \o \bold {The \\table command and the corresponding \\endtable
- command delimit the contents of a table.}
+ The \\table command and the corresponding \\endtable
+ command delimit the contents of a table.
The command accepts a single argument specifying the
table's width in percentage:
@@ -2609,9 +2503,9 @@
the table will be centered in the generated documentation.
A table can contain headers, rows and columns. A row starts
- with a \l {row} {\\row} command and consists of cells, which
- starts with a \l {o} {\\o} command. There is also a \l
- {header} {\\header} command which is a special kind of row
+ with a \l {row-command} {\\row} command and consists of cells, which
+ starts with a \l {o-command} {\\o} command. There is also a \l
+ {header-command} {\\header} command which is a special kind of row
with a special formatting. For example:
\code
@@ -2638,7 +2532,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2699,7 +2593,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2" cellspacing="1"
@@ -2728,16 +2622,18 @@
</table>
\endraw
- See also \l {header} {\\header}, \l {row} {\\row} and \l {o} {\\o}.
+ See also \l {header-command} {\\header}, \l {row-command} {\\row} and \l {o-command} {\\o}.
- \row
- \o \bold \\header \target header
- \o \bold {The \\header command indicates that the following
- table cells are the current table's column headers.}
- The command can only be used within the \l{table}
+ \section1 \\header
+ \target header-command
+
+ The \\header command indicates that the following
+ table cells are the current table's column headers.
+
+ The command can only be used within the \l{table-command}
{\\table...\\endtable} commands. A header can contain
- several cells. A cell is created with the \l {o} {\\o}
+ several cells. A cell is created with the \l {o-command} {\\o}
command.
A header cell's text is centered within the table cell and
@@ -2757,7 +2653,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2778,16 +2674,18 @@
</table>
\endraw
- See also \l {table} {\\table}, \l {row} {\\row} and \l {o} {\\o}.
+ See also \l {table-command} {\\table}, \l {row-command} {\\row} and \l {o-command} {\\o}.
- \row
- \o \bold \\row \target row
- \o \bold {The \\row command indicates that the following table
- cells belong to the same row in the current table.}
- The command can only be used within the \l{table}
+ \section1 \\row
+ \target row-command
+
+ The \\row command indicates that the following table
+ cells belong to the same row in the current table.
+
+ The command can only be used within the \l{table-command}
{\\table...\\endtable} commands. A row can contain
- several cells. A cell is created with the \l {o} {\\o}
+ several cells. A cell is created with the \l {o-command} {\\o}
command.
The background cell color of each row alternate between two
@@ -2820,7 +2718,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -2860,13 +2758,15 @@
</table>
\endraw
- See also \l {table} {\\table}, \l {header} {\\header} and \l
- {o} {\\o}.
+ See also \l {table-command} {\\table}, \l {header-command} {\\header} and \l
+ {o-command} {\\o}.
- \row
- \o \bold \\value \target value-command
- \o \bold {The \\value command starts the documentation of a C++ enum
- item}.
+
+ \section1 \\value
+ \target value-command
+
+ The \\value command starts the documentation of a C++ enum
+ item.
The command's first argument is the enum item. Then follows
its associated description. The description argument ends
@@ -2879,10 +2779,12 @@
See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}.
- \row
- \o \bold \\omitvalue \target omitvalue-command
- \o \bold {The \\omitvalue command excludes a C++ enum item
- from the documentation}.
+
+ \section1 \\omitvalue
+ \target omitvalue-command
+
+ The \\omitvalue command excludes a C++ enum item
+ from the documentation.
The command's only argument is the name of the enum item
that will be omitted. See the \l {enum-command} {\\enum}
@@ -2890,13 +2792,15 @@
See also \l {enum-command} {\\enum} and \l {value-command} {\\value}.
- \row
- \o \bold \\list \target list
- \o \bold {The \\list command and the corresponding \\endlist
- command delimit a list of items.}
+
+ \section1 \\list
+ \target list-command
+
+ The \\list command and the corresponding \\endlist
+ command delimit a list of items.
You need to create each list item explicitly using the \l
- {o} {\\o} command. A list can contain one or more items; it
+ {o-command} {\\o} command. A list can contain one or more items; it
can also be nested. For example:
\code
@@ -2918,7 +2822,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\list
\o Qt Reference Documentation: Getting Started
@@ -3009,7 +2913,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\list G
\o How to Learn Qt
@@ -3017,26 +2921,28 @@
\o Tutorial and Examples
\endlist
- See also \l {o} {\\o}.
+ See also \l {o-command} {\\o}.
- \row
- \o \bold \\o \target o
- \o \bold {The \\o command announce a table or list item.}
- Earlier we used the \l {i} {\\i} command for this purpose. For more
+ \section1 \\o
+ \target o-command
+
+ The \\o command announce a table or list item.
+
+ Earlier we used the \l {i-command} {\\i} command for this purpose. For more
information see the \l
{26-qdoc-commands-compatibility.html#o-versus-i} {compatibility}
section.
- The command can only be used within the \l{table}
- {\\table...\\endtable} or \l{list} {\\list... \\endlist}
+ The command can only be used within the \l{table-command}
+ {\\table...\\endtable} or \l{list-command} {\\list... \\endlist}
commands.
It considers everything until the next occurrence
of the \\o command, or the currently applicable \l
- {table} {\\endtable} or \l {list} {\\endlist} command, as its
- argument. For examples, see \l {table} {\\table} and \l
- {list} {\\list}.
+ {table-command} {\\endtable} or \l {list-command} {\\endlist} command, as its
+ argument. For examples, see \l {table-command} {\\table} and \l
+ {list-command} {\\list}.
If the command is used within a table, you can in addition
specify how many rows or columns the item should span. For
@@ -3060,7 +2966,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2" cellspacing="1"
@@ -3091,45 +2997,28 @@
If not specified, the item will span one column and one row.
- See also \l {table} {\\table}, \l {header} {\\header},
- \l {list} {\\list} and \l {o} {\\o}.
- \endtable
+ See also \l {table-command} {\\table}, \l {header-command} {\\header},
+ \l {list-command} {\\list} and \l {o-command} {\\o}.
+
*/
/*!
- \page 11-qdoc-commands-documentcontents.html
- \previouspage Container Commands
+ \page 11-qdoc-commands-specialcontent.html
+ \previouspage Tables and Lists
\contentspage Table of Contents
- \nextpage Miscellaneous Commands
+ \nextpage Miscellaneous
- \title Document Contents Commands
+ \title Special Content
The document contents commands identify parts of the documentation,
i.e. parts with a special rendering, conceptual meaning or
function.
- \section1 Alphabetical List
-
- \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract},
- \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief},
- \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote},
- \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese},
- \l {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents},
- \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation},
- \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\abstract
+ \target abstract-command
- \row
- \o \bold \\abstract \target abstract
- \o \bold {The \\abstract command and the corresponding \\endabstract
- command delimit a document's abstract section.}
+ The \\abstract and \\endabstract commands delimit a
+ document's abstract section.
The abstract section is rendered as an indented italicized
paragraph.
@@ -3138,54 +3027,64 @@
have not been implemented. The abstract section is rendered as a
regular HTML paragraph.
- \row
- \o \bold \\quotation \target quotation
- \o \bold { The \\quotation command and the corresponding
- \\endquotation command delimit a quotation remark.}
- This command replaces the old \\quote command. For more
- information see the \l
- {26-qdoc-commands-compatibility.html#quotation-versus-quote}
- {compatibility} section.
+ \section1 \\quotation
+ \target quotation-command
- The remark is rendered as a separate centered
- paragraph. For example:
+ The \\quotation and \\endquotation commands delimit a long quotation.
- \code
- / *!
- While the prospect of a significantly broader market is
- good news for Firstlogic, the notion also posed some
- challenges. Dave Dobson, director of technology for the La
- Crosse, Wisconsin-based company, said:
+ The text in the delimited block is surrounded by \bold{<blockquote>}
+ and \bold{</blockquote>} in the html output, e.g.:
+ \code
+ / *!
+ While the prospect of a significantly broader market is
+ good news for Firstlogic, the notion also posed some
+ challenges. Dave Dobson, director of technology for the La
+ Crosse, Wisconsin-based company, said:
+
+ \quotation
+ As our solutions were being adopted into new
+ environments, we saw an escalating need for easier
+ integration with a wider range of enterprise
+ applications.
+ \endquotation
+ * /
+ \endcode
- \quotation
- As our solutions were being adopted into new
- environments, we saw an escalating need for easier
- integration with a wider range of enterprise
- applications.
- \endquotation
- * /
- \endcode
+ The text in the \bold{\\quotation} block will appear in the generated HTML as:
- will be rendered as
+ \code
+ <blockquote>
+ <p>As our solutions were being adopted into new environments,
+ we saw an escalating need for easier integration with a wider
+ range of enterprise applications.</p>
+ </blockquote>
+ \endcode
- While the prospect of a significantly broader market is
- good news for Firstlogic, the notion also posed some
- challenges. Dave Dobson, director of technology for the La
- Crosse, Wisconsin-based company, said:
+ The built-in style sheet for most browsers will render the
+ contents of the <blockquote> tag with left and right
+ indentations. The example above would be rendered as:
- \quotation
- As our solutions were being adopted into new
- environments, we saw an escalating need for easier
- integration with a wider range of enterprise
- applications.
- \endquotation
+ \quotation
+ As our solutions were being adopted into new
+ environments, we saw an escalating need for easier
+ integration with a wider range of enterprise
+ applications.
+ \endquotation
- \row
- \o \bold \\footnote \target footnote
- \o \bold {The \\footnote command and the corresponding
- \\endfootnote command delimit a footnote.}
+ But you can redefine the \bold{<blockquote>} tag in your style.css file.
+
+ This command replaces the old \\quote command. For more information
+ see the \l {26-qdoc-commands-compatibility.html#quotation-versus-quote}
+ {compatibility} section.
+
+
+ \section1 \\footnote
+ \target footnote-command
+
+ The \\footnote command and the corresponding
+ \\endfootnote command delimit a footnote.
The footnote is rendered at the bottom of the page.
@@ -3193,19 +3092,23 @@
commands have not been implemented. The footnote is
rendered as a regular HTML paragraph.
- \row
- \o \bold \\tableofcontents \target tableofcontents
- \o \bold {The \\tableofcontents command has been disabled because QDoc
- now generates a table of contents automatically.}
+
+ \section1 \\tableofcontents
+ \target tableofcontents-command
+
+ The \\tableofcontents command has been disabled because QDoc
+ now generates a table of contents automatically.
The automatically generated table of contents appears in the upper
righthand corner of the page.
- \row
- \o \bold \\brief \target brief-command
- \o \bold {The \\brief command introduces a one-sentence
- description of a class, namespace, header file, property
- or variable.}
+
+ \section1 \\brief
+ \target brief-command
+
+ The \\brief command introduces a one-sentence
+ description of a class, namespace, header file, property
+ or variable.
The brief text is used to introduce the documentation of
the associated object, and in lists generated using the \l
@@ -3219,9 +3122,10 @@
\target brief-property
When the \\brief command is used to describe a property or
- a variable, the brief text must only be a sentence fragment
- and start with "whether" (for boolean properties and
- variables) or "the" (for any other property or variable).
+ a variable, the brief text must be a sentence fragment
+ starting with "whether" (for a boolean property or
+ variable) or starting with "the" (for any other property
+ or variable).
For example the boolean QWidget::isWindow property:
@@ -3258,7 +3162,7 @@
* /
\endcode
- The latter will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3321,7 +3225,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -3406,7 +3310,7 @@
<h3>PreviewWindow(QWidget *parent = 0)</h3>
\endraw
- Constructs a preview window widget with \i parent.
+ Constructs a preview window widget with \e parent.
\target function
\raw HTML
@@ -3448,105 +3352,84 @@
* /
\endcode
- See also \l{property} {\\property}, \l{class-command} {\\class},
- \l{namespace} {\\namespace} and \l{headerfile} {\\headerfile}.
+ See also \l{property-command} {\\property}, \l{class-command} {\\class},
+ \l{namespace-command} {\\namespace} and \l{headerfile-command} {\\headerfile}.
- \row
- \o \bold \\legalese \target legalese
- \o \bold {The \\legalese command, and the corresponding \\endlegalese
- command, delimit a licence agreement.}
-
- If the \\endlegalese command is omitted, QDoc will still
- process the \\legalese command but considers the rest of
- the documentation page as the license agreement.
-
- Ideally, the license documentation is located where the
- licensed code is used.
- Later the documentation identified by the \\legalese
- command can be accumulated into a list using the \l
- {generatelist-command} {\\generatelist} command with the \c legalese
- argument. This is useful to generate an overview of all the
- licenses associated with the source code.
+ \section1 \\legalese
+ \target legalese-command
- For example:
+ The \\legalese and \\endlegalese commands delimit a licence agreement.
- \code
- \ * !
- ...
+ In the generated HTML, the delimited text is surrounded by a
+ \bold {<div class="LegaleseLeft">} and \bold {</div>} tags.
- On X11, Qt also supports drops via the Motif Drag \&
- Drop Protocol. The implementation incorporates some
- code that was originally written by Daniel Dardailler,
- and adapted for Qt by Matt Koss \<koss@napri.sk\> and
- Trolltech. Here is the original copyright notice:
+ For example, here is a license agreement enclosed in \\legalese and
+ \\endlegalese:
- \legalese
- \code
-
- Copyright 1996 Daniel Dardailler.
-
- Permission to use, copy, modify, distribute, and sell
- this software for any purpose is hereby granted without
- fee, provided that the above copyright notice appear in
- all copies and that both that copyright notice and this
- permission notice appear in supporting documentation,
- and that the name of Daniel Dardailler not be used in
- advertising or publicity pertaining to distribution of
- the software without specific, written prior
- permission. Daniel Dardailler makes no representations
- about the suitability of this software for any
- purpose. It is provided "as is" without express or
- implied warranty.
-
- Modifications Copyright 1999 Matt Koss, under the same
- license as above.
-
- \ endcode
- \endlegalese
- * /
- \endcode
-
- will be rendered as
-
- \quotation
- ...
-
- On X11, Qt also supports drops via the Motif Drag \&
- Drop Protocol. The implementation incorporates some
- code that was originally written by Daniel Dardailler,
- and adapted for Qt by Matt Koss \<koss@napri.sk\> and
- Trolltech. Here is the original copyright notice:
-
- \legalese
- \code
-
- Copyright 1996 Daniel Dardailler.
-
- Permission to use, copy, modify, distribute, and sell
- this software for any purpose is hereby granted without
- fee, provided that the above copyright notice appear in
- all copies and that both that copyright notice and this
- permission notice appear in supporting documentation,
- and that the name of Daniel Dardailler not be used in
- advertising or publicity pertaining to distribution of
- the software without specific, written prior
- permission. Daniel Dardailler makes no representations
- about the suitability of this software for any
- purpose. It is provided "as is" without express or
- implied warranty.
-
- Modifications Copyright 1999 Matt Koss, under the same
- license as above.
-
- \endcode
- \endlegalese
- \endquotation
+ \code
+ / *!
+ \legalese
+ Copyright 1996 Daniel Dardailler.
+
+ Permission to use, copy, modify, distribute, and sell this
+ software for any purpose is hereby granted without fee,
+ provided that the above copyright notice appear in all
+ copies and that both that copyright notice and this
+ permission notice appear in supporting documentation, and
+ that the name of Daniel Dardailler not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission. Daniel
+ Dardailler makes no representations about the suitability of
+ this software for any purpose. It is provided "as is"
+ without express or implied warranty.
+
+ Modifications Copyright 1999 Matt Koss, under the same
+ license as above.
+ \endlegalese
+ * /
+ \endcode
- \row
- \o \bold \\warning \target warning
- \o \bold {The \\warning command renders a "Warning:" prefix to
- the command's argument.}
+ It will appear in the generated HTML as:
+
+ \code
+ <div class="LegaleseLeft">
+ <p>Copyright 1996 Daniel Dardailler.</p>
+ <p>Permission to use, copy, modify, distribute, and sell
+ this software for any purpose is hereby granted without fee,
+ provided that the above copyright notice appear in all
+ copies and that both that copyright notice and this
+ permission notice appear in supporting documentation, and
+ that the name of Daniel Dardailler not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission. Daniel
+ Dardailler makes no representations about the suitability of
+ this software for any purpose. It is provided "as is"
+ without express or implied warranty.</p>
+
+ <p>Modifications Copyright 1999 Matt Koss, under the same
+ license as above.</p>
+ </div>
+ \endcode
+
+ If the \\endlegalese command is omitted, QDoc will still
+ process the \\legalese command but considers the rest of the
+ documentation page as the license agreement.
+
+ Ideally, the license text is located with the licensed code.
+
+ Elsewhere, the documentation identified as \e{\\legalese}
+ command can be accumulated using \l {generatelist-command}
+ {\\generatelist} with \c {legalese-command} as the argument. This is
+ useful for generating an overview of the license agreements
+ associated with the source code.
+
+
+ \section1 \\warning
+ \target warning-command
+
+ The \\warning command renders a "Warning:" prefix to
+ the command's argument.
For example:
@@ -3561,7 +3444,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Qt::HANDLE is a platform-specific handle type
@@ -3571,45 +3454,26 @@
\warning Using this type is not portable.
\endquotation
- \endtable
+
*/
/*!
\page 12-0-qdoc-commands-miscellaneous.html
- \previouspage Document Contents Commands
+ \previouspage Special Content
\contentspage Table of Contents
- \nextpage Topical Commands
+ \nextpage The QDoc Configuration File
- \title Miscellaneous Commands
+ \title Miscellaneous
These commands provide miscellaneous functions
connected to the visual appearance of the documentation, and to the
process of generating the documentation.
- \section1 Alphabetical List
-
- \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else},
- \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif},
- \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire},
- \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist},
- \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if},
- \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include},
- \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta},
- \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)},
- \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\unicode}
-
- \section1 Command Descriptions
+ \section1 \\expire
+ \target expire-command
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\expire \target expire
- \o \bold {The \\expire command allows you to define an expiration
- date for your documentation.}
+ The \\expire command allows you to define an expiration
+ date for your documentation.
When using the \\expire command, QDoc will emit a warning
when the current date is larger than the specified
@@ -3639,10 +3503,12 @@
porting.qdoc:6: Documentation expired 185 days ago
\endquotation
- \row
- \o \bold \\generatelist \target generatelist-command
- \o \bold {The \\generatelist command expands to a list of
- various documentation or links to documentation.}
+
+ \section1 \\generatelist
+ \target generatelist-command
+
+ The \\generatelist command expands to a list of
+ various documentation or links to documentation.
For example in the Qt Reference Documentation:
@@ -3666,8 +3532,7 @@
\target table example
- \list
- \o \c annotatedclasses
+ \section2 \c annotatedclasses
The \c annotatedclasses argument provides a table
containing the names of all the classes, and a
@@ -3676,6 +3541,18 @@
For example:
+ \table
+ \row
+ \o QDial
+ \o Rounded range control (like a speedometer or potentiometer)
+ \row
+ \o QDialog
+ \o The base class of dialog windows
+ \row
+ \o QDir
+ \o Access to directory structures and their contents
+ \endtable
+
\quotation
\raw HTML
<table align="center" cellpadding="2"
@@ -3717,7 +3594,7 @@
\target list example
- \o \c classes
+ \section2 \c classes
The \c classes argument provides a complete alphabetical
list of the classes. Each class name is a link to the
@@ -3768,7 +3645,7 @@
A class is identified within the documentation by the
the \l {class-command} {\\class} command.
- \o \c classesbymodule
+ \section2 \c classesbymodule
This particular argument requests an additional argument,
i.e. a specification of the module.
@@ -3805,7 +3682,7 @@
is related to a module with the \l
{inmodule-command} {\\inmodule} command.
- \o \c classesbyedition
+ \section2 \c classesbyedition
This particular argument requests an additional argument,
i.e. a specification of the edition.
@@ -3829,20 +3706,20 @@
The edition a given class can be found in is determined by
the module it belongs to.
- \o \c compatclasses
+ \section2 \c compatclasses
The \c compatclasses argument provides a complete and
alphabetical list of the support classes. A support
class is identified within the documentation by the \l
- {compat} {\\compat} command. Each class name is a link to
- the class's reference documentation. The list is
- rendered similarily to the list generated by the \l
+ {compat-command} {\\compat} command. Each class name is
+ a link to the class's reference documentation. The list
+ is rendered similarily to the list generated by the \l
{list example} {\c classes} argument.
\warning The \c classesbymodule argument will at some
point replace the this argument.
- \o \c functionindex
+ \section2 \c functionindex
The \c functionindex argument provides a complete
alphabetical list of all the documented member
@@ -3869,11 +3746,11 @@
...
\endquotation
- \o \c legalese
+ \section2 \c legalese
The \c legalese argument provides a complete list of all
the licenses. The licenses are identified within the
- documentation using the \l {legalese} {\\legalese}
+ documentation using the \l {legalese-command} {\\legalese}
command.
For example:
@@ -3928,7 +3805,7 @@
...
\endquotation
- \o \c mainclasses
+ \section2 \c mainclasses
The \c mainclasses argument provides a complete
alphabetical list of the main classes. Each class name
@@ -3939,17 +3816,18 @@
The list is rendered similarily to the list generated by
the \l {list example} {\c classes} argument.
- \o \c overviews
+ \section2 \c overviews
The \c overviews argument provides a complete
alphabetical overview of the documentation. Each list
entry is a link to the respective documentation page.
The list includes pages declared using commands like \l
- {page} {\\page} and \l {group-command} {\\group}. The list omits
- examples and classes, and only lists the first page of
- documentation that contains two or more pages using
- commands like \l {nextpage-command} {\\nextpage}.
+ {page-command} {\\page} and \l {group-command}
+ {\\group}. The list omits examples and classes, and only
+ lists the first page of documentation that contains two
+ or more pages using commands like \l {nextpage-command}
+ {\\nextpage}.
For example:
@@ -4003,37 +3881,36 @@
\endraw
\endquotation
- \o \c related
+ \section2 \c related
The \c related argument is used in combination with the
\l {group-command} {\\group} command to list all the overviews
related to the given group. Each list entry is a link to
the respective documentation page.
- \o \c relatedinline
+ \section2 \c relatedinline
The \c related argument is used in combination with the
\l {group-command} {\\group} command to collect all documentation
related to the given group. The various documentation
snippets are copied directly into the group page.
- \o \c service
+ \section2 \c service
The \c service argument provides a complete alphabetical
list of the services. Each service name is a link to the
service's reference documentation.
A service is identified within the documentation by the
- \l {service} {\\service} command.
+ \l {service-command} {\\service} command.
- \endlist
+ \section1 \\if
+ \target if-command
- \row
- \o \bold \\if \target if-command
- \o \bold {The \\if command and the corresponding \\endif command
- enclose parts of a QDoc comment that only will be included if
- the condition specified by the command's argument is true.}
+ The \\if command and the corresponding \\endif command
+ enclose parts of a QDoc comment that only will be included if
+ the condition specified by the command's argument is true.
The command reads the rest of the line and parses it as an
C++ #if statement. For example:
@@ -4064,27 +3941,32 @@
command line. For more information see the documentation of
the \l {defines-variable} {defines} variable.
- See also \l{endif} {\\endif}, \l{else} {\\else}, \l
- {defines-variable} {defines} and \l {falsehoods-variable}
- {falsehoods}.
+ See also \l{endif-command} {\\endif}, \l{else-command}
+ {\\else}, \l {defines-variable} {defines} and \l
+ {falsehoods-variable} {falsehoods}.
- \row
- \o \bold \\endif \target endif
- \o \bold {The \\endif command and the corresponding \\if command
- enclose parts of a QDoc comment that will be included if
- the condition specified by the \l {if-command} {\\if} command's
- argument is true.}
+
+ \section1 \\endif
+ \target endif-command
+
+ The \\endif command and the corresponding \\if command
+ enclose parts of a QDoc comment that will be included if
+ the condition specified by the \l {if-command} {\\if} command's
+ argument is true.
For more information, see the documentation of the \l
{if-command} {\\if} command.
- See also \l{if-command} {\\if}, \l{else} {\\else}, \l
- {defines-variable} {defines} and \l {falsehoods-variable} {falsehoods}.
+ See also \l{if-command} {\\if}, \l{else-command} {\\else},
+ \l {defines-variable} {defines} and \l
+ {falsehoods-variable} {falsehoods}.
- \row
- \o \bold \\else \target else
- \o \bold {The \\else command specifies an alternative if the
- condition in the \l {if-command} {\\if} command is false.}
+
+ \section1 \\else
+ \target else-command
+
+ The \\else command specifies an alternative if the
+ condition in the \l {if-command} {\\if} command is false.
The \\else command can only be used within \l
{if-command} {\\if...\\endif} commands, but is useful when there is
@@ -4136,7 +4018,7 @@
\endquotation
If \c QT3_SUPPORT isn't defined but \c QT3_SUPPORT_WARNINGS
- is, the comment will be rendered as
+ is, the comment QDoc renders this as:
\quotation
The Qt 3 support library is provided to keep old source
@@ -4175,14 +4057,16 @@
GCC 3.2+ and MSVC 7.)
\endquotation
- See also \l{if-command} {\\if}, \l{endif} {\\endif}, \l
+ See also \l{if-command} {\\if}, \l{endif-command} {\\endif}, \l
{defines-variable} {defines} and \l {falsehoods-variable}
{falsehoods}.
- \row
- \o \bold \\include \target include
- \o \bold {The \\include command expands to the contents of the
- file specified by the command's argument.}
+
+ \section1 \\include
+ \target include-command
+
+ The \\include command expands to the contents of the
+ file specified by the command's argument.
\warning This is preliminary functionality. For more
information, see the \l
@@ -4214,31 +4098,33 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
<h1>Core Features</h1>
\endraw
- \include examples/signalandslots.qdocinc
- \include examples/objectmodel.qdocinc
- \include examples/layoutmanagement.qdocinc
+ \input examples/signalandslots.qdocinc
+ \input examples/objectmodel.qdocinc
+ \input examples/layoutmanagement.qdocinc
\endquotation
Here is the actual \c .qdocinc files: \l
signalandslots.qdocinc, \l objectmodel.qdocinc, \l
layoutmanagement.qdocinc
- \row
- \o \bold \\meta \target meta
- \o \bold {The \\meta command is the QDoc equivalent to the HTML
- \c meta tag.}
+
+ \section1 \\meta
+ \target meta-command
+
+ The \\meta command is the QDoc equivalent to the HTML
+ \c meta tag.
The command accepts two arguments: The first argument (the
- following word) is equivalent to the HTML meta tag's \i
+ following word) is equivalent to the HTML meta tag's \e
name variable, and the second argument (the rest of the
- line) is equivalent to the tag's \i contents variable.
+ line) is equivalent to the tag's \e contents variable.
For example:
@@ -4274,11 +4160,13 @@
</head>
\endcode
- \row
- \o \bold \\omit \target omit
- \o \bold {The \\omit command and the correspondning \\endomit
- command delimit parts of the documentation that
- you want QDoc to skip.}
+
+ \section1 \\omit
+ \target omit-command
+
+ The \\omit command and the correspondning \\endomit
+ command delimit parts of the documentation that
+ you want QDoc to skip.
For example:
@@ -4304,7 +4192,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\raw HTML
<table align="center" cellpadding="2"
@@ -4324,16 +4212,19 @@
\endraw
- \row
- \o \bold \\raw \span {class="newStuff"} {(avoid)} \target raw
- \o \bold {The \\raw command and the corresponding
- \\endraw command delimit a block of raw mark-up language code.}
+
+ \section1 \\raw \span {class="newStuff"} {(avoid)}
+ \target raw-command
+
+ The \\raw command and the corresponding
+ \\endraw command delimit a block of raw mark-up language code.
\note Avoid using this command if possible, because it generates
DITA XML code that causes problems. If you are trying to generate
special table or list behavior, try to get the behavior you want
- using the \l {span} {\\span} and \l {div} {\\div} commands in your
- \l {table} {\\table} or \l {list} {\\list}.
+ using the \l {span-command} {\\span} and \l {div-command} {\\div}
+ commands in your \l {table-command} {\\table} or \l {list-command}
+ {\\list}.
The command takes an argument specifying the code's format;
currently the only supported format is HTML.
@@ -4361,7 +4252,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
Qt has some predefined QColor objects. For example:
@@ -4397,10 +4288,12 @@
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
- \row
- \o \bold \\unicode \target unicode
- \o \bold {The \\unicode command allows you to insert an
- arbitrary Unicode character in the document.}
+
+ \section1 \\unicode
+ \target unicode-command
+
+ The \\unicode command allows you to insert an
+ arbitrary Unicode character in the document.
The command takes an argument specifying the character as
an integer. By default, base 10 is assumed, unless a '0x'
@@ -4412,24 +4305,24 @@
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
- \unicode 0x3A3 \i{a}\sub{\i{i}}
+ \unicode 0x3A3 \e{a}\sub{\e{i}}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
O G\unicode{0xEA}nio e as Rosas
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
- \unicode 0x3A3 \i{a}\sub{\i{i}}
+ \unicode 0x3A3 \e{a}\sub{\e{i}}
\endquotation
- \endtable
+
*/
/*!
\page 12-1-signalandslots.html
- \previouspage Miscellaneous Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\title signalandslots.qdocinc
@@ -4439,7 +4332,7 @@
/*!
\page 12-2-objectmodel.html
- \previouspage Miscellaneous Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\title objectmodel.qdocinc
@@ -4449,7 +4342,7 @@
/*!
\page 12-3-layoutmanagement.html
- \previouspage Miscellaneous Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\title layoutmanagement.qdocinc
@@ -4458,48 +4351,30 @@
*/
/*!
- \page 13-qdoc-commands-topical.html
- \previouspage Miscellaneous Commands
+ \page 13-qdoc-commands-topics.html
+ \previouspage The QDoc Commands
\contentspage Table of Contents
- \nextpage Contextual Commands
+ \nextpage Context Commands
- \title Topical Commands
+ \title Topic Commands
- The topical commands tell QDoc what is being documented
+ The topic commands tell QDoc what is being documented
(i.e. existing units like classes, functions and examples), and
some of the commands allows you to create extra pages.
- \section1 Alphabetical List
-
- \l {13-qdoc-commands-topical.html#class-command} {\\class},
- \l {13-qdoc-commands-topical.html#enum-command} {\\enum},
- \l {13-qdoc-commands-topical.html#example-command} {\\example},
- \l {13-qdoc-commands-topical.html#externalpage} {\\externalpage},
- \l {13-qdoc-commands-topical.html#fn} {\\fn},
- \l {13-qdoc-commands-topical.html#group-command} {\\group},
- \l {13-qdoc-commands-topical.html#headerfile} {\\headerfile},
- \l {13-qdoc-commands-topical.html#macro} {\\macro},
- \l {13-qdoc-commands-topical.html#module} {\\module},
- \l {13-qdoc-commands-topical.html#namespace} {\\namespace},
- \l {13-qdoc-commands-topical.html#page} {\\page},
- \l {13-qdoc-commands-topical.html#property} {\\property},
- \l {13-qdoc-commands-topical.html#service} {\\service},
- \l {13-qdoc-commands-topical.html#typedef} {\\typedef},
- \l {13-qdoc-commands-topical.html#variable} {\\variable},
-
\section1 General Description
When QDoc is processing a comment, it will try to connect the
documentation to the source code. For that reason it will first
- look for the topical commands. If there is no such command, it
+ look for the topic commands. If there is no such command, it
will try to tie the documentation to the immediately following
- code. If there is no topical command, and the documentation cannot
+ code. If there is no topic command, and the documentation cannot
be tied to following code, the documentation is simply lost.
- \target topical argument
+ \target topic argument
The documented unit's name is passed as the unique argument for
- all the topical commands. The argument's naming convention is the
+ all the topic commands. The argument's naming convention is the
documented unit's complete name. For example:
\code
@@ -4507,21 +4382,21 @@
\endcode
Functions is a special case, the argument's naming convention for
- the \l {fn} {\\fn} command is that of the function's definition
- outside the class definition. For example:
+ the \l {fn-command} {\\fn} command is that of the function's
+ definition outside the class definition. For example:
\code
\fn void PreviewWindow::setWindowFlags()
\endcode
- A topical command can appear anywhere in a comment, but must stand
+ A topic command can appear anywhere in a comment, but must stand
alone on its own line. If the argument spans several lines, make
sure that each line (except the last one) is ended with a
backslash. In addition QDoc counts parentheses, which means that
if it encounters a '(' it considers everything until the closing
')' as its argument.
- If a topical command is repeated with different arguments, the
+ If a topic command is repeated with different arguments, the
same documentation will appear for both the units. For example:
\code
@@ -4542,21 +4417,15 @@
ControllerWindow::setWindowFlags() functions will get the same
documentation.
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\class
+ \target class-command
- \row
- \o \bold \\class \target class-command
- \o \bold {The \\class command tells QDoc that a class is
- part of the public API, and lets you enter a detailed
- description.}
+ The \\class command tells QDoc that a class is
+ part of the public API, and lets you enter a detailed
+ description.
- The command follows \l {topical argument} {the general
- topical command convention} for the argument, and supports
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument, and supports
nested classes, for example:
\code
@@ -4586,7 +4455,7 @@
The command is typically accompanied with a \l
{brief-command} {\\brief} command, a \l {mainclass-command} {\\mainclass}
command, an \l {ingroup-command} {\\ingroup} command and a \l
- {sa} {\\sa} command. For example:
+ {sa-command} {\\sa} command. For example:
\code
/ *!
@@ -4609,7 +4478,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -4695,7 +4564,7 @@
<h3>PreviewWindow(QWidget *parent = 0)</h3>
\endraw
- Constructs a preview window widget with \i parent.
+ Constructs a preview window widget with \e parent.
\target function
\raw HTML
@@ -4711,12 +4580,14 @@
the text in the widgets text editor.
\endquotation
- \row
- \o \bold \\enum \target enum-command
- \o \bold {The \\enum command allows you to document a C++ enum.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\enum
+ \target enum-command
+
+ The \\enum command allows you to document a C++ enum.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The enum items are documented using the \l {value-command} {\\value}
command. If an item isn't documented, QDoc will emit a
@@ -4767,7 +4638,7 @@
* /
\endcode
- this associated QDoc comment will be rendered as
+ this associated QDoc comment QDoc renders this as:
\quotation
\raw HTML
@@ -4814,18 +4685,19 @@
See also \l {value-command} {\\value} and \l {omitvalue-command} {\\omitvalue}.
- \row
- \o \bold \\example \target example-command
- \o \bold {The \\example command allows you to document an
- example.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument. In particular
+ \section1 \\example
+ \target example-command
+
+ The \\example command allows you to document an example.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument. In particular
the command's argument is the example's path relative to
the paths listed in the \l {exampledirs-variable}
{exampledirs} configuration variable.
- The documentation will be located in \i
+ The documentation will be located in \e
{path-to-example}.html, and QDoc will add a list of all the
example files at the top of this documentation page.
@@ -4845,7 +4717,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -4870,12 +4742,14 @@
in widgets-imageviewer.html.
- \row
- \o \bold \\fn \target fn
- \o \bold {The \\fn command allows you to document a function.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument. In particular
+ \section1 \\fn
+ \target fn-command
+
+ The \\fn command allows you to document a function.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument. In particular
it is important that the return type of the function,
whether it is \c const or not and the complete set of
arguments with type are included in the argument. If the
@@ -4883,7 +4757,7 @@
warning.
Also, the \\fn command is QDoc's default command, i.e. when
- no topical command can be found within a QDoc comment, QDoc
+ no topic command can be found within a QDoc comment, QDoc
tries to tie the documentation to the following code as if
it was function documentation.
@@ -4904,7 +4778,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -4916,20 +4790,22 @@
\a area; otherwise returns false.
\endquotation
- See also \l {overload} {\\overload}.
+ See also \l {overload-command} {\\overload}.
- \row
- \o \bold \\group \target group-command
- \o \bold {The \\group command creates a separate page that
- lists the classes belonging to the group specified by the
- command's argument.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument. The \\group
+ \section1 \\group
+ \target group-command
+
+ The \\group command creates a separate page that
+ lists the classes belonging to the group specified by the
+ command's argument.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument. The \\group
command is typically followed by a \l {title-command} {\\title}
command and a short introduction to the group. The
generated HTML documentation for the specified group is put
- in <lower-case>\i{group}.html.
+ in <lower-case>\e{group}.html.
A class can be related to a group by using the \l
{ingroup-command} {\\ingroup} command. In addition, overviews can be
@@ -4953,7 +4829,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5017,15 +4893,17 @@
See also \l {ingroup-command} {\\ingroup} and \l
{generatelist-command} {\\generatelist}.
- \row
- \o \bold \\headerfile \target headerfile
- \o \bold {The \\headerfile command allows you to document
- global functions, types and macros declared in a header file.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument, and the
+ \section1 \\headerfile
+ \target headerfile-command
+
+ The \\headerfile command allows you to document
+ global functions, types and macros declared in a header file.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument, and the
generated HTML documentation for the specified header file
- is put in <lower-case>\i{headerfilename}.html.
+ is put in <lower-case>\e{headerfilename}.html.
A function, type or macro can be associated with a
headerfile using the \l {relates-command} {\\relates} command.
@@ -5051,7 +4929,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5059,7 +4937,7 @@
Generic Algorithms</h1></center>
<p>The <QtAlgorithms> header file provides generic
template-based algorithms.
- <a href="13-qdoc-commands-topical.html#header">More...</a>
+ <a href="13-qdoc-commands-topics.html#header-command">More...</a>
</p>
<h3>Functions</h3>
@@ -5089,12 +4967,14 @@
in qtalgorithms.html.
- \row
- \o \bold \\macro \target macro
- \o \bold {The \\macro command allows you to document a C++ macro.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\macro
+ \target macro-command
+
+ The \\macro command allows you to document a C++ macro.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
QDoc recognizes three different macro syntax: function-like
macros like Q_ASSERT(), declaration-style macros like
@@ -5121,7 +5001,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5152,7 +5032,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5185,7 +5065,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5205,14 +5085,16 @@
in qobject.html.
- \row
- \o \bold \\module \target module
- \o \bold {The \\module creates a separate page that lists the
- classes belonging to the module specified by the command's
- argument.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\module
+ \target module-command
+
+ The \\module creates a separate page that lists the
+ classes belonging to the module specified by the command's
+ argument.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
A class can be related to a module using the \l
{inmodule-command} {\\inmodule} command.
@@ -5243,7 +5125,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5310,18 +5192,19 @@
See also \l {inmodule-command} {\\inmodule}
- \row
- \o \bold \\namespace \target namespace
- \o \bold {The \\namespace command allows you to document a C++
- namespace.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\namespace
+ \target namespace-command
+
+ The \\namespace command allows you to document a C++ namespace.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
QDoc will generate the same additional links and
documentation for all the members of the namespace as it
does for \l {framework} {classes}. The documentation for
- the specified namespace is put in <lower-case>\i
+ the specified namespace is put in <lower-case>\e
{namespace}.html.
For example:
@@ -5335,14 +5218,14 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
<center><h1>Qt Namespace Reference</h1></center>
<p>The Qt namespace contains miscellaneous
identifiers used throughout the Qt library.
- <a href="13-qdoc-commands-topical.html#name">More...</a>
+ <a href="13-qdoc-commands-topics.html#name">More...</a>
</p>
<pre>#include &lt;Qt&gt;</pre>
@@ -5374,13 +5257,14 @@
in qt.html.
- \row
- \o \bold \\page \target page
- \o \bold {The \\page command allows you to create a stand-alone
- documentation page.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\page
+ \target page-command
+
+ The \\page command allows you to create a stand-alone documentation page.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The page's title can be set using the \l {title-command} {\\title}
command. For example:
@@ -5410,13 +5294,14 @@
will be rendered in its own HTML file: \l{About Qt}.
- \row
- \o \bold {\\externalpage} \target externalpage
- \o \bold {The \\externalpage command gives a title to
- an external URL.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\externalpage
+ \target externalpage-command
+
+ The \\externalpage command gives a title to an external URL.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
For example:
@@ -5438,7 +5323,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
The broad scope of the \l
@@ -5464,13 +5349,14 @@
documentation. If the adress changes, you only need to change the
argument of the \\externalpage command.
- \row
- \o \bold \\property \target property
- \o \bold {The \\property command allows you to document a Qt
- property.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\property
+ \target property-command
+
+ The \\property command allows you to document a Qt property.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
A property is defined using the Q_PROPERTY() macro. The
macro takes as arguments the property's name and its set,
@@ -5492,9 +5378,9 @@
property, the \l {brief-command} {\\brief} command's
argument is a sentence fragment that will be included in a
one-sentence description of the property generated by
- QDoc. The command follows the same rules for the
- \l {brief-property} {description} as the \l {variable}
- {\\variable} command.
+ QDoc. The command follows the same rules for the \l
+ {brief-property} {description} as the \l {variable-command}
+ {\\variable} command.
For example:
@@ -5507,7 +5393,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5541,7 +5427,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5566,12 +5452,13 @@
in qwidget.html.
- \row
- \o \bold \\service \target service
- \o \bold {The \\service command tells QDoc that a class is a
- service class and specifies its alias, i.e. the associated
- service's name.}
+ \section1 \\service
+ \target service-command
+
+ The \\service command tells QDoc that a class is a
+ service class and specifies its alias, i.e. the associated
+ service's name.
The command takes two arguments, the service class's name
and the associated alias. For example:
@@ -5590,13 +5477,14 @@
See also \l {class-command} {\\class} and \l
{generatelist-command} {\\generatelist}.
- \row
- \o \bold \\typedef \target typedef
- \o \bold {The \\typedef command allows you to document a C++ type
- definition.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\typedef
+ \target typedef-command
+
+ The \\typedef command allows you to document a C++ type definition.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The documentation will be located in the associated class,
header file or namespace documentation. When documenting a
@@ -5613,7 +5501,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5641,7 +5529,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5672,7 +5560,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5684,19 +5572,21 @@
in qlinkedlist.html.
- \row
- \o \bold \\variable \target variable
- \o \bold {The \\variable command allows you to document a
- member variable or a constant.}
- The command follows \l {topical argument} {the general
- topical command convention} for the argument.
+ \section1 \\variable
+ \target variable-command
+
+ The \\variable command allows you to document a
+ member variable or a constant.
+
+ The command follows \l {topic argument} {the general
+ topic command convention} for the argument.
The \\variable command is typically followed by a
\l {brief-command} {\\brief} command; QDoc will generate the
documentation for the variable based on the brief command
description. The command follows the same rules for the
- \l {brief-property} {description} as the \l {property}
+ \l {brief-property} {description} as the \l {property-command}
{\\property} command.
The documentation will be located in the in the associated
@@ -5712,7 +5602,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5763,7 +5653,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5792,77 +5682,71 @@
\endquotation
in qtreewidget.html.
- \endtable
+
*/
/*!
- \page 14-qdoc-commands-contextualcommands.html
- \previouspage Topical Commands
+ \page 14-qdoc-commands-contextcommands.html
+ \previouspage Topic Commands
\contentspage Table of Contents
- \nextpage Navigation Commands
+ \nextpage Navigating
- \title Contextual Commands
+ \title Context Commands
- The contextual commands provide QDoc with information, that it
+ The context commands provide QDoc with information, that it
wouldn't figure out otherwise, about the documented object. For
example whether a class is thread-safe or not.
These commands can appear anywhere within a QDoc comment.
- \section1 Alphabetical List
-
- \l {16-qdoc-commands-status.html#compat} {\\compat},
- \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
- \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
- \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
- \l {16-qdoc-commands-status.html#internal} {\\internal},
- \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
- \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage},
- \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
- \l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
- \l {18-qdoc-commands-relating.html#overload} {\\overload},
- \l {16-qdoc-commands-status.html#preliminary} {\\preliminary},
- \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
- \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant},
- \l {18-qdoc-commands-relating.html#reimp} {\\reimp},
- \l {18-qdoc-commands-relating.html#relates-command} {\\relates},
- \l {15-qdoc-commands-navigation.html#startpage} {\\startpage},
- \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe},
- \l {20-qdoc-commands-title.html#title-command} {\\title}
-
\section1 Categories
\list
- \o \l {Navigation Commands}
- \o \l {Status Commands}
- \o \l {Thread Support Commands}
- \o \l {Relating Commands}
- \o \l {Grouping Commands}
- \o \l {Title Commands}
+ \o \l {Navigating}
+ \o \l {Reporting Status}
+ \o \l {Thread Support}
+ \o \l {Relating Things}
+ \o \l {Grouping Things}
+ \o \l {Naming Things}
+ \endlist
+
+ \section1 Command List
+
+ \list
+ \o \l {16-qdoc-commands-status.html#compat-command} {\\compat}
+ \o \l {15-qdoc-commands-navigation.html#contentspage-command} {\\contentspage}
+ \o \l {15-qdoc-commands-navigation.html#indexpage-command} {\\indexpage}
+ \o \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup}
+ \o \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule}
+ \o \l {16-qdoc-commands-status.html#internal-command} {\\internal}
+ \o \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass}
+ \o \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage}
+ \o \l {17-qdoc-commands-thread.html#nonreentrant-command} {\\nonreentrant}
+ \o \l {16-qdoc-commands-status.html#obsolete-command} {\\obsolete}
+ \o \l {18-qdoc-commands-relating.html#overload-command} {\\overload}
+ \o \l {16-qdoc-commands-status.html#preliminary-command} {\\preliminary}
+ \o \l {15-qdoc-commands-navigation.html#previouspage-command} {\\previouspage}
+ \o \l {17-qdoc-commands-thread.html#reentrant-command} {\\reentrant}
+ \o \l {18-qdoc-commands-relating.html#reimp-command} {\\reimp}
+ \o \l {18-qdoc-commands-relating.html#relates-command} {\\relates}
+ \o \l {15-qdoc-commands-navigation.html#startpage-command} {\\startpage}
+ \o \l {17-qdoc-commands-thread.html#threadsafe-command} {\\threadsafe}
+ \o \l {20-qdoc-commands-namingthings.html#title-command} {\\title}
\endlist
*/
/*!
\page 15-qdoc-commands-navigation.html
- \previouspage Contextual Commands
+ \previouspage Context Commands
\contentspage Table of Contents
- \nextpage Status Commands
+ \nextpage Reporting Status
- \title Navigation Commands
+ \title Navigating
The navigation commands allow you to link the pages of a multipage
document together. They provide the components of a navigation bar
at the top and bottom of the document. They also provide browser
and search engine support.
- \section1 Alphabetical List
-
- \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage},
- \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage},
- \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage},
- \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage},
- \l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
-
\section1 General Description
The QDoc comments below shows a typical example using the
@@ -5938,7 +5822,7 @@
\endcode
The second page of this multipage document, "Getting Started",
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -5975,8 +5859,8 @@
in creatingdialogs.html.
- In addition, the \l {indexpage} {\\indexpage} and \l
- {startpage} {\\startpage} commands specifies links to the page's
+ In addition, the \l {indexpage-command} {\\indexpage} and \l
+ {startpage-command} {\\startpage} commands specifies links to the page's
index page and start page. These links are used by browsers and
search engines.
@@ -5996,17 +5880,11 @@
</head>
\endcode
- \section1 Command Descriptions
+ \section1 \\previouspage
+ \target previouspage-command
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\previouspage \target previouspage
- \o \bold {The \\previouspage command links the current page
- to the previous one in an ordered series of documents}.
+ The \\previouspage command links the current page
+ to the previous one in an ordered series of documents.
The command has two arguments, each enclosed by curly
braces: The first is the link target, i.e. the title of the
@@ -6020,20 +5898,24 @@
the current page. For an example, see the \l {General
Description} section.
- \row
- \o \bold \\nextpage \target nextpage-command
- \o \bold {The \\nextpage command links the current
- page to the next page in an ordered series of documents}.
+
+ \section1 \\nextpage
+ \target nextpage-command
+
+ The \\nextpage command links the current
+ page to the next page in an ordered series of documents.
The command follows the same syntax and argument convention
- as the \l {previouspage} {\\previouspage} command.
+ as the \l {previouspage-command} {\\previouspage} command.
For an example, see the \l {General Description} section.
- \row
- \o \bold \\startpage \target startpage
- \o \bold {The \\startpage command specifies the first document
- in a collection of documents.}
+
+ \section1 \\startpage
+ \target startpage-command
+
+ The \\startpage command specifies the first document
+ in a collection of documents.
The command must stand alone on its own line, and its
unique argument is the title of the first document.
@@ -6046,20 +5928,24 @@
For an example, see the \l {General Description} section.
- \row
- \o \bold \\contentspage \target contentspage
- \o \bold {The \\contentspage command links the current
- page to a contents page}.
+
+ \section1 \\contentspage
+ \target contentspage-command
+
+ The \\contentspage command links the current
+ page to a contents page.
The command follows the same syntax and argument convention
- as the \l {previouspage} {\\previouspage} command.
+ as the \l {previouspage-command} {\\previouspage} command.
For an example, see the \l {General Description} section.
- \row
- \o \bold \\indexpage \target indexpage
- \o \bold {The \\indexpage command specifies a document providing
- an index for the current document}.
+
+ \section1 \\indexpage
+ \target indexpage-command
+
+ The \\indexpage command specifies a document providing
+ an index for the current document.
The command must stand alone on its own line, and its
unique argument is the title of the index document.
@@ -6072,16 +5958,16 @@
For an example, see the \l {General Description} section.
- \endtable
+
*/
/*!
\page 16-qdoc-commands-status.html
- \previouspage Navigation Commands
+ \previouspage Navigating
\contentspage Table of Contents
- \nextpage Thread Support Commands
+ \nextpage Thread Support
- \title Status Commands
+ \title Reporting Status
The usage commands can indicate whether a documented object is
under development, becoming obsolete, provided for compatibility
@@ -6089,25 +5975,11 @@
describe the history of minor versions. And they can also describe
a documented object's ability to handle multithreaded programming.
- \section1 Alphabetical List
+ \section1 \\preliminary
+ \target preliminary-command
- \l {16-qdoc-commands-status.html#compat} {\\compat},
- \l {16-qdoc-commands-status.html#internal} {\\internal},
- \l {16-qdoc-commands-status.html#obsolete} {\\obsolete},
- \l {16-qdoc-commands-status.html#preliminary} {\\preliminary},
- \l {16-qdoc-commands-status.html#since} {\\since}
-
- \section1 Command Description
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\preliminary \target preliminary
- \o \bold {The \\preliminary command indicates that the
- referenced function is under development.}
+ The \\preliminary command indicates that the
+ referenced function is under development.
The command must stand on its own line.
@@ -6129,7 +6001,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6160,12 +6032,14 @@
\endlist
\endquotation
- \row
- \o \bold \\obsolete \target obsolete
- \o \bold {The \\obsolete command indicates that the referenced
- function no longer should be used in new code;
- there is no guarantee for how long it will remain in
- the library.}
+
+ \section1 \\obsolete
+ \target obsolete-command
+
+ The \\obsolete command indicates that the referenced
+ function no longer should be used in new code;
+ there is no guarantee for how long it will remain in
+ the library.
The command must stand on its own line.
@@ -6185,7 +6059,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6216,11 +6090,13 @@
in myclass-obsolete.html
- \row
- \o \bold \\compat \target compat
- \o \bold {The \\compat command indicates that the referenced class
- or function is part of the support library provided to keep
- old source code working.}
+
+ \section1 \\compat
+ \target compat-command
+
+ The \\compat command indicates that the referenced class
+ or function is part of the support library provided to keep
+ old source code working.
The command must stand on its own line.
@@ -6239,7 +6115,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\bold {This class is part of the Qt 3 support
@@ -6266,7 +6142,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6298,10 +6174,12 @@
in myclass-qt3.html
- \row
- \o \bold \\internal \target internal
- \o \bold {The \\internal command indicates that the referenced
- function is not part of the public interface.}
+
+ \section1 \\internal
+ \target internal-command
+
+ The \\internal command indicates that the referenced
+ function is not part of the public interface.
The command must stand on its own line.
@@ -6329,10 +6207,12 @@
in qspinbox.cpp, will not be rendered at all.
- \row
- \o \bold \\since \target since
- \o \bold {The \\since command tells in which minor release
- the associated functionality was added.}
+
+ \section1 \\since
+ \target since-command
+
+ The \\since command tells in which minor release
+ the associated functionality was added.
For example:
@@ -6351,7 +6231,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6379,26 +6259,20 @@
{25-qdoc-configuration-derivedprojects.html#project} {\c
project}.
- \endtable
+
*/
/*!
\page 17-qdoc-commands-thread.html
- \previouspage Status Commands
+ \previouspage Reporting Status
\contentspage Table of Contents
- \nextpage Relating Commands
+ \nextpage Relating Things
- \title Thread Support Commands
+ \title Thread Support
The thread support commands specify the level of support for
multithreaded programming of a class or function.
- \section1 Alphabetical List
-
- \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant},
- \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant},
- \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
-
\section1 General Description
There are three levels of support for multithreaded programming of
@@ -6417,10 +6291,10 @@
invocation references shared data.
When a class is declared \c reentrant or \c threadsafe, using the
- \l {reentrant} {\\reentrant} and \l {threadsafe} {\\threadsafe}
+ \l {reentrant-command} {\\reentrant} and \l {threadsafe-command} {\\threadsafe}
commands respectively, functions in the referenced class can be
declared \c nonreentrant, using the \l
- {nonreentrant} {\\nonreentrant} command, excluding the functions
+ {nonreentrant-command} {\\nonreentrant} command, excluding the functions
from the general view.
For example:
@@ -6463,7 +6337,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6525,90 +6399,76 @@
For more information see the general documentation on \l
{threads.html#reentrant} {reentrancy and thread-safety}.
- \section1 Command Descriptions
+ \section1 \\threadsafe
+ \target threadsafe-command
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\threadsafe \target threadsafe
- \o \bold {The \\threadsafe command indicates that the
- associated class or function can be called simultaneously by
- multiple threads even when each invocation references
- shared data.}
+ The \\threadsafe command indicates that the
+ associated class or function can be called simultaneously by
+ multiple threads even when each invocation references
+ shared data.
The command must stand on its own line.
The generated documentation resulting from using the
\\threadsafe command is similar to the result of using the
- \l {reentrant} {\\reentrant} command. For an example, see
+ \l {reentrant-command} {\\reentrant} command. For an example, see
the \l {General Description} section.
- See also \l{reentrant} {\\reentrant} and
- \l{nonreentrant} {\\nonreentrant}.
+ See also \l{reentrant-command} {\\reentrant} and
+ \l{nonreentrant-command} {\\nonreentrant}.
- \row
- \o \bold \\reentrant \target reentrant
- \o \bold {The \\reentrant command indicates that the associated
- class or function can be called simultaneously
- by multiple threads, provided that each invocation of the
- functions reference unique data.}
+
+ \section1 \\reentrant
+ \target reentrant-command
+
+ The \\reentrant command indicates that the associated
+ class or function can be called simultaneously
+ by multiple threads, provided that each invocation of the
+ functions reference unique data.
The command must stand on its own line.
For an example, see the \l {General Description} section.
- See also \l{nonreentrant} {\\nonreentrant} and
- \l{threadsafe} {\\threadsafe}.
+ See also \l{nonreentrant-command} {\\nonreentrant} and
+ \l{threadsafe-command} {\\threadsafe}.
- \row
- \o \bold \\nonreentrant \target nonreentrant
- \o \bold {The \\nonreentrant command indicates that the
- associated class or function cannot be called by
- multiple threads.}
+
+ \section1 \\nonreentrant
+ \target nonreentrant-command
+
+ The \\nonreentrant command indicates that the
+ associated class or function cannot be called by
+ multiple threads.
The command must stand on its own line.
For an example, see the \l {General Description} section.
- See also \l{reentrant} {\\reentrant} and
- \l{threadsafe} {\\threadsafe}.
+ See also \l{reentrant-command} {\\reentrant} and
+ \l{threadsafe-command} {\\threadsafe}.
+
- \endtable
*/
/*!
\page 18-qdoc-commands-relating.html
- \previouspage Thread Support Commands
+ \previouspage Thread Support
\contentspage Table of Contents
- \nextpage Grouping Commands
+ \nextpage Grouping Things
- \title Relating Commands
+ \title Relating Things
The relation commands discribe how the documented object relates
to its context: Whether it is an overloaded function, a
reimplemented function or a global function related to a specified
class or header file.
- \section1 Alphabetical List
-
- \l {18-qdoc-commands-relating.html#overload} {\\overload},
- \l {18-qdoc-commands-relating.html#reimp} {\\reimp},
- \l {18-qdoc-commands-relating.html#relates-command} {\\relates},
+ \section1 \\overload
+ \target overload-command
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\overload \target overload
- \o \bold {The \\overload command indicates that the
- function is a secondary overload of its name.}
+ The \\overload command indicates that the
+ function is a secondary overload of its name.
The command must stand on its own line.
@@ -6621,7 +6481,7 @@
From Qt 4.5, you can include the function name plus '()'
as a parameter to the \bold{\\overload} command, which
- will include a standard \i{This function overloads...}
+ will include a standard \e{This function overloads...}
line of text with a link to the documentation for the
primary version of the function.
@@ -6646,7 +6506,7 @@
}
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6659,7 +6519,7 @@
This function overloads \l {http://qt.nokia.com/doc/4.0/qwidget.html#addAction} {addAction()}
This convenience function creates a new action with an
- \i icon and some \i text. The function adds the newly
+ \e icon and some \e text. The function adds the newly
created action to the menu's list of actions, and
returns it.
@@ -6679,11 +6539,13 @@
convenience.
\endquotation.
- \row
- \o \bold \\reimp \target reimp
- \o \bold {The \\reimp command indicates that the
- referenced function is a reimplementation of a virtual function,
- where the reimplementation has no effect on the interface.}
+
+ \section1 \\reimp
+ \target reimp-command
+
+ The \\reimp command indicates that the
+ referenced function is a reimplementation of a virtual function,
+ where the reimplementation has no effect on the interface.
The command must stand on its own line.
@@ -6708,10 +6570,12 @@
QAbstractButton::nextCheckState() will appear in the
documentation.
- \row
- \o \bold \\relates \target relates-command
- \o \bold {The \\relates command attaches the documentation of
- a global function to that of a related class or header file.}
+
+ \section1 \\relates
+ \target relates-command
+
+ The \\relates command attaches the documentation of
+ a global function to that of a related class or header file.
The command's argument is a class name, an the command (and
its argument) must stand on its own line.
@@ -6735,39 +6599,27 @@
will be rendered with the QChar documentation.
- \endtable
+
*/
/*!
\page 19-qdoc-commands-grouping.html
- \previouspage Relating Commands
+ \previouspage Relating Things
\contentspage Table of Contents
- \nextpage Title Commands
+ \nextpage Naming Things
- \title Grouping Commands
+ \title Grouping Things
The grouping commands relate classes to defined groups and
modules. The groups are used when generating lists of related
classes in the documentation, while the modules are elements of
Qt's structure.
- \section1 Alphabetical List
-
- \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup},
- \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule},
- \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass},
-
- \section1 Command Descriptions
-
- \table
- \header
- \o Command
- \o Description
+ \section1 \\mainclass
+ \target mainclass-command
- \row
- \o \bold \\mainclass \target mainclass-command
- \o \bold {The \\mainclass command relates the documented class to
- a group called mainclasses.}
+ The \\mainclass command relates the documented class to
+ a group called mainclasses.
The command must stand on its own line.
@@ -6795,12 +6647,13 @@
See also \l {generatelist-command} {\\generatelist}.
- \row
- \o \bold \\ingroup \target ingroup-command
- \o \bold {The \\ingroup command indicates that the given
- overview or documented class belongs to a certain group of
- related docmentation.}
+ \section1 \\ingroup
+ \target ingroup-command
+
+ The \\ingroup command indicates that the given
+ overview or documented class belongs to a certain group of
+ related docmentation.
A class or overview may belong to many groups.
@@ -6831,10 +6684,12 @@
argument.
See also \l {group-command} {\\group}.
- \row
- \o \bold \\inmodule \target inmodule-command
- \o \bold {The \\inmodule command relates the documented class
- to the module specified by the command's argument.}
+
+ \section1 \\inmodule
+ \target inmodule-command
+
+ The \\inmodule command relates the documented class
+ to the module specified by the command's argument.
For the basic classes in Qt, a class's module is determined
by its location, i.e. its directory. However, for
@@ -6859,40 +6714,29 @@
calling the \l {generatelist-command} {\\generatelist} command with
the \c {{classesbymodule QtDesigner}} argument.
- See also \l {module} {\\module} and \l
+ See also \l {module-command} {\\module} and \l
{generatelist-command} {\\generatelist}.
- \endtable
+
*/
/*!
- \page 20-qdoc-commands-title.html
- \previouspage Grouping Commands
+ \page 20-qdoc-commands-namingthings.html
+ \previouspage Grouping Things
\contentspage Table of Contents
- \nextpage QDoc Configuration
+ \nextpage Markup Commands
- \title Title Commands
+ \title Naming Things
In general a title command considers everything that follows it
until the first line break as its argument. If the title needs to
be spanned over several lines, make sure to end each line (except
the last one) with a backslash.
- \section1 Alphabetical List
-
- \l {20-qdoc-commands-title.html#title-command} {\\title},
- \l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
-
- \section1 Command Descriptions
+ \section1 \\title
+ \target title-command
- \table
- \header
- \o Command
- \o Description
-
- \row
- \o \bold \\title \target title-command
- \o \bold {The \\title command sets the title for a
- documentation page, or allows you to override it.}
+ The \\title command sets the title for a
+ documentation page, or allows you to override it.
For example:
@@ -6911,7 +6755,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6925,12 +6769,14 @@
...
\endquotation
- See also \l {subtitle} {\\subtitle}.
+ See also \l {subtitle-command} {\\subtitle}.
- \row
- \o \bold \\subtitle \target subtitle
- \o \bold {The \\subtitle command sets a subtitle for a
- documentation page.}
+
+ \section1 \\subtitle
+ \target subtitle-command
+
+ The \\subtitle command sets a subtitle for a
+ documentation page.
For example:
@@ -6949,7 +6795,7 @@
* /
\endcode
- will be rendered as
+ QDoc renders this as:
\quotation
\raw HTML
@@ -6965,35 +6811,64 @@
\endquotation
See also \l {title-command} {\\title}.
- \endtable
+
*/
+
+ \list II
+ \o \section2 \l {The QDoc Configuration File}
+
+ The configuration file is a list of entries of entries of the
+ form "variable = value".
+
+ \list
+ \o \l {Configuration Variables}
+ \o \l {Configuration File Examples}
+ \endlist
+
+ Some particular configuration variables allow you to use QDoc
+ to support Qt-based projects; i.e to make projects, such as Qt
+ Solutions, contain references to the online Qt documentation.
+
+ \list
+ \o \l {Supporting Derived Projects}
+ \endlist
+
+ QDoc is a tool that constantly evolves to suit our needs, for
+ that reason there are some compatibility issues between old and
+ new practices.
+
+ \list
+ \o \l {Compatibility Issues}
+ \endlist
+ \endlist
+
+
+
/*!
\page 21-0-qdoc-configuration.html
- \previouspage Title Commands
+ \previouspage Miscellaneous
\contentspage Table of Contents
\nextpage General Configuration Variables
- \title QDoc Configuration
+ \title The QDoc Configuration File
- \tableofcontents
+ Before running QDoc to to extract and format your QDOC comments,
+ you must create a QDoc configuration file to tell QDoc where to find
+ them.
\list
\o \l {Supporting Derived Projects}
- \o \l {QDoc Compatibility}
+ \o \l {Compatibility Issues}
\endlist
When running QDoc to generate the documentation, you must specify
a configuration file on the command line:
- \quotation
- \bold {/currentdirectory$ qdoc3 my-documentation.qdocconf}
- \endquotation
-
\section1 General Description
The configuration file is a list of entries of entries of the form
- \i {"variable = value"}. Using the configuration variables, you
+ \e {"variable = value"}. Using the configuration variables, you
can define where QDoc should find the various source files, images
and examples, where to put generated documentation etc. The
configuration file can also contain directives like \c
@@ -7047,49 +6922,43 @@
\section1 Configuration Variables
- \section2 Alphabetical List
-
- \l {22-qdoc-configuration-generalvariables.html#alias} {alias},
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
- {Cpp.ignoredirectives},
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
- {Cpp.ignoretokens},
- \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
- \l {22-qdoc-configuration-generalvariables.html#edition} {edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs},
- \l {22-qdoc-configuration-generalvariables.html#examples} {examples},
- \l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
- {examples.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods},
- \l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
- \l {22-qdoc-configuration-generalvariables.html#headers} {headers},
- \l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
- {headers.fileextensions},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.footer} {HTML.footer},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
- {HTML.postheader},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.style} {HTML.style},
- \l {22-qdoc-configuration-generalvariables.html#imagedirs} {imagedirs},
- \l {22-qdoc-configuration-generalvariables.html#images} {images},
- \l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
- {images.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#language} {language},
- \l {22-qdoc-configuration-generalvariables.html#macro} {macro},
- \l {22-qdoc-configuration-generalvariables.html#outputdir} {outputdir},
- \l {22-qdoc-configuration-generalvariables.html#outputformats}
- {outputformats},
- \l {22-qdoc-configuration-generalvariables.html#slow} {slow},
- \l {22-qdoc-configuration-generalvariables.html#sourcedirs} {sourcedirs},
- \l {22-qdoc-configuration-generalvariables.html#sources} {sources},
- \l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
- {sources.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#spurious} {spurious},
- \l {22-qdoc-configuration-generalvariables.html#tabsize} {tabsize},
- \l {22-qdoc-configuration-generalvariables.html#version} {version},
- \l {22-qdoc-configuration-generalvariables.html#versionsym} {versionsym}
+ \section1 Variable List
- \section2 Categories
+ \list
+ \o \l {22-qdoc-configuration-generalvariables.html#alias-variable} {alias}
+ \o \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives-variable} {Cpp.ignoredirectives}
+ \o \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretokens-variable} {Cpp.ignoretokens}
+ \o \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines}
+ \o \l {22-qdoc-configuration-generalvariables.html#edition-variable} {edition}
+ \o \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#examples-variable} {examples}
+ \o \l {22-qdoc-configuration-generalvariables.html#examples.fileextensions-variable} {examples.fileextensions}
+ \o \l {22-qdoc-configuration-generalvariables.html#extraimages-variable} {extraimages}
+ \o \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods}
+ \o \l {22-qdoc-configuration-generalvariables.html#headerdirs-variable} {headerdirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#headers-variable} {headers}
+ \o \l {22-qdoc-configuration-generalvariables.html#headers.fileextensions-variable} {headers.fileextensions}
+ \o \l {24-qdoc-configuration-htmlvariables.html#HTML.footer-variable} {HTML.footer}
+ \o \l {24-qdoc-configuration-htmlvariables.html#HTML.postheader-variable} {HTML.postheader}
+ \o \l {24-qdoc-configuration-htmlvariables.html#HTML.style-variable} {HTML.style}
+ \o \l {22-qdoc-configuration-generalvariables.html#imagedirs-variable} {imagedirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#images-variable} {images}
+ \o \l {22-qdoc-configuration-generalvariables.html#images.fileextensions-variable} {images.fileextensions}
+ \o \l {22-qdoc-configuration-generalvariables.html#language-variable} {language}
+ \o \l {22-qdoc-configuration-generalvariables.html#macro-variable} {macro}
+ \o \l {22-qdoc-configuration-generalvariables.html#outputdir-variable} {outputdir}
+ \o \l {22-qdoc-configuration-generalvariables.html#outputformats-variable} {outputformats}
+ \o \l {22-qdoc-configuration-generalvariables.html#slow-variable} {slow}
+ \o \l {22-qdoc-configuration-generalvariables.html#sourcedirs-variable} {sourcedirs}
+ \o \l {22-qdoc-configuration-generalvariables.html#sources-variable} {sources}
+ \o \l {22-qdoc-configuration-generalvariables.html#sources.fileextensions-variable} {sources.fileextensions}
+ \o \l {22-qdoc-configuration-generalvariables.html#spurious-variable} {spurious}
+ \o \l {22-qdoc-configuration-generalvariables.html#tabsize-variable} {tabsize}
+ \o \l {22-qdoc-configuration-generalvariables.html#version-variable} {version}
+ \o \l {22-qdoc-configuration-generalvariables.html#versionsym-variable} {versionsym}
+ \endlist
+
+ \section1 Categories
\list
\o \l {General Configuration Variables}
@@ -7107,8 +6976,9 @@
/*!
\page 21-1-minimum-qdocconf.html
- \previouspage QDoc Configuration
+ \previouspage qt.qdocconf
\contentspage Table of Contents
+ \nextpage Table of Contents
\title minimum.qdocconf
@@ -7117,8 +6987,9 @@
/*!
\page 21-2-qt-qdocconf.html
- \previouspage QDoc Configuration
+ \previouspage Compatibility Issues
\contentspage Table of Contents
+ \nextpage minimum.qdocconf
\title qt.qdocconf
@@ -7127,7 +6998,7 @@
/*!
\page 22-qdoc-configuration-generalvariables.html
- \previouspage QDoc Configuration
+ \previouspage The QDoc Configuration File
\contentspage Table of Contents
\nextpage Creating Help Project Files
@@ -7139,57 +7010,13 @@
documentation. You can also do some minor manipulation of QDoc
itself, controlling its output and processing behavior.
- \section1 Alphabetical List
-
- \l {22-qdoc-configuration-generalvariables.html#alias} {alias},
- \l {22-qdoc-configuration-generalvariables.html#codeindent} {codeindent},
- \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines},
- \l {22-qdoc-configuration-generalvariables.html#edition} {edition},
- \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs},
- \l {22-qdoc-configuration-generalvariables.html#examples} {examples},
- \l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
- {examples.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#extraimages} {extraimages},
- \l {22-qdoc-configuration-generalvariables.html#falsehoods-variable} {falsehoods},
- \l {22-qdoc-configuration-generalvariables.html#generateindex} {generateindex},
- \l {22-qdoc-configuration-generalvariables.html#headerdirs} {headerdirs},
- \l {22-qdoc-configuration-generalvariables.html#headers} {headers},
- \l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
- {headers.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#imagedirs} {imagedirs},
- \l {22-qdoc-configuration-generalvariables.html#images} {images},
- \l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
- {images.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#language} {language},
- \l {22-qdoc-configuration-generalvariables.html#macro} {macro},
- \l {22-qdoc-configuration-generalvariables.html#outputdir} {outputdir},
- \l {22-qdoc-configuration-generalvariables.html#outputformats}
- {outputformats},
- \l {22-qdoc-configuration-generalvariables.html#slow} {slow},
- \l {22-qdoc-configuration-generalvariables.html#sourcedirs} {sourcedirs},
- \l {22-qdoc-configuration-generalvariables.html#sources} {sources},
- \l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
- {sources.fileextensions},
- \l {22-qdoc-configuration-generalvariables.html#spurious} {spurious},
- \l {22-qdoc-configuration-generalvariables.html#tabsize} {tabsize},
- \l {22-qdoc-configuration-generalvariables.html#tagfile} {tagfile},
- \l {22-qdoc-configuration-generalvariables.html#version} {version},
- \l {22-qdoc-configuration-generalvariables.html#versionsym} {versionsym}
-
- \section1 Variable Descriptions
-
- \table
-
- \header
- \o Variable
- \o Description
+ \section1 alias
+ \target alias-variable
- \row
- \o \bold alias \target alias
- \o \bold {The \c alias variable renames a QDoc command.}
+ The \c alias variable renames a QDoc command.
- The general syntax is \tt {alias.\i{original-command-name}
- = \i temporary-command-name}.
+ The general syntax is \tt {alias.\e{original-command-name}
+ = \e temporary-command-name}.
For example:
@@ -7200,15 +7027,17 @@
renames the built-in command \\i (italics) to \\e.
The \c alias variable is often used for compatibility
- reasons; for more information see the \l {QDoc
- Compatibility} {compatibility section}.
+ reasons; for more information see the
+ \l {Compatibility Issues} {compatibility section}.
- See also \l macro.
+ See also \l {macro-command} {macro}.
- \row
- \o \bold codeindent \target codeindent
- \o \bold {The \c codeindent variable specifies the level of
- indentation that QDoc uses when writing code snippets.}
+
+ \section1 codeindent
+ \target codeindent-variable
+
+ The \c codeindent variable specifies the level of
+ indentation that QDoc uses when writing code snippets.
QDoc originally used a hard-coded value of four spaces for
code indentation to ensure that code snippets could be easily
@@ -7217,10 +7046,12 @@
adjust the appearance of certain types of HTML elements, this
level of indentation is not always required.
- \row
- \o \bold defines \target defines-variable
- \o \bold {The \c defines variable specifies the C++ preprocessor
- symbols that QDoc will recognize and respond to.}
+
+ \section1 defines
+ \target defines-variable
+
+ The \c defines variable specifies the C++ preprocessor
+ symbols that QDoc will recognize and respond to.
When a preprocessor symbol is specified using the \c
defines variable, you can also use the \l {if-command} {\\if}
@@ -7273,11 +7104,13 @@
See also \l {falsehoods-variable} {falsehoods} and \l {if-command} {\\if}.
- \row
- \o \bold edition \target edition
- \o \bold {The \c edition variable specifies which modules are
- included in each edition of a package, and provides QDoc
- with information to provide class lists for each edition.}
+
+ \section1 edition
+ \target edition-variable
+
+ The \c edition variable specifies which modules are
+ included in each edition of a package, and provides QDoc
+ with information to provide class lists for each edition.
This feature is mostly used when providing documentation
for Qt packages.
@@ -7296,29 +7129,33 @@
In the above examples, the \c Console edition only includes
the contents of four modules. Only the classes from these
modules will be used when the
- \l{Miscellaneous Commands#generatelist-command} {generatelist} command
+ \l{Miscellaneous#generatelist-command} {generatelist} command
is used to generate a list of classes for this edition:
\code
\generatelist{classesbyedition Console}
\endcode
- \row
- \o \bold exampledirs \target exampledirs-variable
- \o \bold {The \c exampledirs variable specifies the directories
- containing the source code of the example files.}
-
- The \l {examples} {\c examples} and \c exampledirs variables
- are used by the \l {quotefromfile-command} {\\quotefromfile}, \l
- {quotefile-command} {\\quotefile} and \l {example} {\\example}
- commands. If both the \l {examples} {\c examples} and \c
- exampledirs variables are defined, QDoc will search in
- both, first in \l {examples} {\c examples} then in \c
- exampledirs.
+
+ \section1 exampledirs
+ \target exampledirs-variable
+
+ The \c exampledirs variable specifies the directories
+ containing the source code of the example files.
+
+ The \l {examples-variable} {examples} {examples} and \l
+ {exampledirs-variable} {exampledirs} variables are used by
+ the \l {quotefromfile-command} {\\quotefromfile}, \l
+ {quotefile-command} {\\quotefile} and \l {example-command}
+ {\\example} commands. If both the \l {examples-variable}
+ {examples} and \l {exampledirs-variable} {exampledirs}
+ variables are defined, QDoc will search in both, first in
+ \l {examples-variable} {examples} then in \l
+ {exampledirs-variable} {exampledirs}.
QDoc will search through the directories in the specified
order, and accept the first matching file it finds. It will
- only search in the specified directories, \i not in
+ only search in the specified directories, \e not in
subdirectories.
For example:
@@ -7359,11 +7196,13 @@
See also \l examples.
- \row
- \o \bold examples \target examples
- \o \bold {The \c examples variable allows you to specify individual
- example files in addition to those located in the directories
- specified by the \l {exampledirs-variable} {\c exampledirs} variable.}
+
+ \section1 examples
+ \target examples-variable
+
+ The \c examples variable allows you to specify individual
+ example files in addition to those located in the directories
+ specified by the \l {exampledirs-variable} {\c exampledirs} variable.
The \c examples and \l {exampledirs-variable} {\c exampledirs}
variables are used by the \l {quotefromfile-command} {\\quotefromfile},
@@ -7387,11 +7226,13 @@
See also \l {exampledirs-variable} {exampledirs}.
- \row
- \o \bold examples.fileextensions \target examples.fileextensions
- \o \bold {The \c examples.fileextensions variable specifies the
- file extensions that qdoc will look for when collecting example
- files for display in the documentation.}
+
+ \section1 examples.fileextensions
+ \target examples.fileextensions-variable
+
+ The \c examples.fileextensions variable specifies the
+ file extensions that qdoc will look for when collecting example
+ files for display in the documentation.
The default extensions are *.cpp, *.h, *.js, *.xq, *.svg, *.xml
and *.ui. However, if
@@ -7406,10 +7247,12 @@
See also \l{headers.fileextensions}.
- \row
- \o \bold extraimages \target extraimages
- \o \bold {The \c extraimages variable tells QDoc to incorporate
- specific images in the generated documentation.}
+
+ \section1 extraimages
+ \target extraimages-variable
+
+ The \c extraimages variable tells QDoc to incorporate
+ specific images in the generated documentation.
QDoc will not recognize images used within HTML (or any
other markup language). If we want the images to be copied
@@ -7418,7 +7261,7 @@
directories) to the output directory, we must specify the
images using the \c extraimages variable.
- The general syntax is \tt {extraimages.\i{format} = \i
+ The general syntax is \tt {extraimages.\e{format} = \e
image}. The file extension is optional.
For example, in \l qt.qdocconf we use a couple of images
@@ -7432,10 +7275,12 @@
See also \l images and \l imagedirs.
- \row
- \o \bold falsehoods \target falsehoods-variable
- \o \bold {The \c falsehoods variable defines the truth value of
- specified preprocessor symbols as false.}
+
+ \section1 falsehoods
+ \target falsehoods-variable
+
+ The \c falsehoods variable defines the truth value of
+ specified preprocessor symbols as false.
If this variable is not set for a preprocessor symbol, QDoc
assumes its truth value is true. The exception is '0',
@@ -7462,7 +7307,7 @@
#endif
\endcode
- QDoc will evaluate it as true by default, \i unless the
+ QDoc will evaluate it as true by default, \e unless the
preprocessor symbol is specified within the \c falsehoods
variable entry:
@@ -7472,21 +7317,25 @@
See also \l defines.
- \row
- \o \bold generateindex \target generateindex
- \o \bold{The \c generateindex variable contains a boolean value that
- specifies whether to generate an index file when HTML documentation
- is generated.}
+
+ \section1 generateindex
+ \target generateindex-variable
+
+ The \c generateindex variable contains a boolean value that
+ specifies whether to generate an index file when HTML documentation
+ is generated.
By default, an index file is always generated with HTML documentation,
so this variable is typically only used when disabling this feature
(by setting the value to \c false) or when enabling index generation
for the WebXML output (by setting the value to \c true).
- \row
- \o \bold headerdirs \target headerdirs
- \o \bold {The \c headerdirs variable specifies the directories
- containing the header files associated with the \c .cpp source
- files used in the documentation.}
+
+ \section1 headerdirs
+ \target headerdirs-variable
+
+ The \c headerdirs variable specifies the directories
+ containing the header files associated with the \c .cpp source
+ files used in the documentation.
For example:
@@ -7507,8 +7356,9 @@
classes and their functions.
Then it will read through the sources specified in the \l
- {sources} {\c sources}, and the ones located in the
- directories specified in the \l {sourcedirs} {\c sourcedirs}
+ {sources-variable} {\c sources}, and the ones located in the
+ directories specified in the \l {sourcedirs-variable}
+ {\c sourcedirs}
varible (including all subdirectories), merging the
documentation with the structure it retrieved from the
header files.
@@ -7527,11 +7377,13 @@
See also \l headers and \l headers.fileextensions.
- \row
- \o \bold headers \target headers
- \o \bold {The \c headers variable allows you to specify individual
- header files in addition to those located in the directories
- specified by the \l {headerdirs} {\c headerdirs} variable.}
+
+ \section1 headers
+ \target headers-variable
+
+ The \c headers variable allows you to specify individual
+ header files in addition to those located in the directories
+ specified by the \l {headerdirs} {\c headerdirs} variable.
For example:
@@ -7547,10 +7399,12 @@
See also \l headerdirs.
- \row
- \o \bold headers.fileextensions \target headers.fileextensions
- \o \bold {The \c headers.fileextensions variable specify the
- extension used by the headers.}
+
+ \section1 headers.fileextensions
+ \target headers.fileextensions-variable
+
+ The \c headers.fileextensions variable specify the
+ extension used by the headers.
When processing the header files specified in the \l
{headerdirs} {\c headerdirs} variable, QDoc will only read
@@ -7573,13 +7427,15 @@
See also \l headerdirs.
- \row
- \o \bold imagedirs \target imagedirs
- \o \bold {The \c imagedirs variable specifies the directories
- containing the images used in the documentation.}
+
+ \section1 imagedirs
+ \target imagedirs-variable
+
+ The \c imagedirs variable specifies the directories
+ containing the images used in the documentation.
The \l {images} {\c images} and \c imagedirs variables are
- used by the \l {image} {\\image} and \l
+ used by the \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage} commands. If both the \l
{images} {\c images} and \c imagedirs variables are defined,
QDoc will search in both, first in \l {images} {\c images}
@@ -7587,7 +7443,7 @@
QDoc will search through the directories in the specified
order, and accept the first matching file it finds. It will
- only search in the specified directories, \i not in
+ only search in the specified directories, \e not in
subdirectories.
For example:
@@ -7633,11 +7489,13 @@
See also \l images and \l images.fileextensions.
- \row
- \o \bold images \target images
- \o \bold {The \c images variable allows you to specify individual
- image files in addition to those located in the directories
- specified by the \l {imagedirs} {\c imagedirs} variable.}
+
+ \section1 images
+ \target images-variable
+
+ The \c images variable allows you to specify individual
+ image files in addition to those located in the directories
+ specified by the \l {imagedirs} {\c imagedirs} variable.
For example:
@@ -7652,14 +7510,16 @@
See also \l imagedirs and \l images.fileextensions.
- \row
- \o \bold images.fileextensions \target images.fileextensions
- \o \bold {The images.fileextensions variable filters the files within
- an image directory.}
+
+ \section1 images.fileextensions
+ \target images.fileextensions-variable
+
+ The images.fileextensions variable filters the files within
+ an image directory.
The variable's values (the extensions) are given as
standard wildcard expressions. The general syntax is: \tt
- {images.fileextensions.\i{format} = *.\i{extension}}.
+ {images.fileextensions.\e{format} = *.\e{extension}}.
The idea is to enable different image format for different
output format. For example:
@@ -7669,7 +7529,7 @@
images.fileextensions.LOUT = *.eps
\endcode
- Then, when processing the \l {image} {\\image} and \l
+ Then, when processing the \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage} commands, QDoc will only
search for files with extensions specified in the output
format's associated image extension variable.
@@ -7689,10 +7549,12 @@
See also \l imagedirs and \l images.
- \row
- \o \bold language \target language
- \o \bold {The \c language variable specifies the language of the
- source code that is used in the documentation.}
+
+ \section1 language
+ \target language-variable
+
+ The \c language variable specifies the language of the
+ source code that is used in the documentation.
Currently, C++ is the only language that QDoc
understands. It is also the default language, and doesn't
@@ -7705,13 +7567,15 @@
identifies the language of the Qt source code as C++.
- \row
- \o \bold macro \target macro
- \o \bold {The \c macro variable can be used to create your
- own QDoc commands.}
- The general syntax is \tt {macro.\i{command} =
- "\i{definition}}". The definition can be described using
+ \section1 macro
+ \target macro-variable
+
+ The \c macro variable can be used to create your
+ own QDoc commands.
+
+ The general syntax is \tt {macro.\e{command} =
+ "\e{definition}}". The definition can be described using
QDoc syntax. In addition it is possible to provide an HTML
definition by appending .HTML to the variable.
@@ -7725,10 +7589,12 @@
makes sure that the \\gui command renders its argument using a
bold font, and that \\raisedaster renders a '*'.
- \row
- \o \bold naturallanguage \target naturallanguage
- \o \bold {The \c naturallanguage variable specifies the natural
- language used for the documentation generated by qdoc.}
+
+ \section1 naturallanguage
+ \target naturallanguage-variable
+
+ The \c naturallanguage variable specifies the natural
+ language used for the documentation generated by qdoc.
For example:
@@ -7742,14 +7608,17 @@
qdoc will add the natural language information to the HTML
it generates, using the \c lang and \c xml:lang attributes.
- See also \l sourceencoding, \l outputencoding,
+ See also \l {sourceencoding-variable} {sourceencoding},
+ \l {outputencoding-variable} {outputencoding},
\l{http://www.w3.org/TR/xhtml1/#C_7} {C.7. The lang and xml:lang Attributes} and
\l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290} {Best Practice 13: Using Hans and Hant codes}.
- \row
- \o \bold outputdir \target outputdir
- \o \bold {The \c outputdir variable specifies the directory
- where QDoc will put the generated documentation.}
+
+ \section1 outputdir
+ \target outputdir-variable
+
+ The \c outputdir variable specifies the directory
+ where QDoc will put the generated documentation.
In qt.qdocconf:
@@ -7770,10 +7639,12 @@
\warning When running QDoc multiple times using the same output
directory, all files from the previous run will be lost.
- \row
- \o \bold outputencoding \target outputencoding
- \o \bold {The \c outputencoding variable specifies the encoding
- used for the documentation generated by qdoc.}
+
+ \section1 outputencoding
+ \target outputencoding-variable
+
+ The \c outputencoding variable specifies the encoding
+ used for the documentation generated by qdoc.
For example:
@@ -7795,26 +7666,32 @@
See also \l outputencoding and \l naturallanguage.
- \row
- \o \bold outputformats \target outputformats
- \o \bold {The \c outputformats variable specifies the format of
- the generated documentation.}
+
+ \section1 outputformats
+ \target outputformats-variable
+
+ The \c outputformats variable specifies the format of
+ the generated documentation.
Currently, QDoc only supports the HTML format. It is also
the default format, and doesn't need to be specified.
- \row
- \o \bold qhp \target qhp
- \o \bold{The \c qhp variable is used to define the information to be
- written out to Qt Help Project (\c{qhp}) files.}
- See the \l{Creating Help Project Files} chapter for information
- about this process.
+ \section1 qhp
+ \target qhp-variable
+
+ The \c qhp variable is used to define the information to be
+ written out to Qt Help Project (\c{qhp}) files.
+
+ See the \l{Creating Help Project Files} chapter for information
+ about this process.
- \row
- \o \bold slow \target slow
- \o \bold {The \c slow variable specifies whether QDoc should do
- time-consuming processing, such as syntax highlighting.}
+
+ \section1 slow
+ \target slow-variable
+
+ The \c slow variable specifies whether QDoc should do
+ time-consuming processing, such as syntax highlighting.
By default, this setting is false.
@@ -7827,11 +7704,13 @@
Another way to turn on "slowness" is to invoke QDoc with the
\c -slow command-line option.
- \row
- \o \bold sourcedirs \target sourcedirs
- \o \bold {The \c sourcedirs variable specifies the directories
- containing the \c .cpp or \c .qdoc files used in
- the documentation.}
+
+ \section1 sourcedirs
+ \target sourcedirs-variable
+
+ The \c sourcedirs variable specifies the directories
+ containing the \c .cpp or \c .qdoc files used in
+ the documentation.
For example in \l qt.qdocconf
@@ -7846,7 +7725,7 @@
\endcode
When executed, the first QDoc will do is to read through
- the headers specified in the \l {header} {\c header}
+ the headers specified in the \l {header-command} {\c header}
variable, and the ones located in the directories specified
in the \c headerdir variable (including all
subdirectories), building an internal structure of the
@@ -7870,12 +7749,15 @@
*.cxx. The files specified by \l {sources} {\c sources} will
be read independent of their fileextensions.
- See also \l sources and \l sources.fileextensions.
+ See also \l {sources-variable} {sources} and
+ \l {sources.fileextensions-variable} {sources.fileextensions}.
- \row
- \o \bold sourceencoding \target sourceencoding
- \o \bold {The \c sourceencoding variable specifies the encoding
- used for the source code and documentation.}
+
+ \section1 sourceencoding
+ \target sourceencoding-variable
+
+ The \c sourceencoding variable specifies the encoding
+ used for the source code and documentation.
For example:
@@ -7894,14 +7776,16 @@
In cases like these, it is possible to write API documentation
completely in documentation files.
- See also \l naturallanguage and \l outputencoding.
+ See also \l {naturallanguage-variable} {naturallanguage} and
+ \l {outputencoding-variable} {outputencoding}.
- \row
- \o \bold sources \target sources
- \o \bold {The \c sources variable allows you to specify
- individual source files in addition to those located in the
- directories specified by the \l {sourcedir} {\c sourcedir}
- variable.}
+
+ \section1 sources
+ \target sources-variable
+
+ The \c sources variable allows you to specify individual source
+ files in addition to those located in the directories specified by
+ the \l {sourcedirs-variable} {sourcedirs} variable.
For example:
@@ -7911,16 +7795,18 @@
\endcode
When processing the \c sources variable, QDoc behaves in the
- same way as it does when processing the \l {sourcedirs} {\c
- sourcedirs} variable. For more information, see the \l
- {sourcedirs} {\c sourcedirs} variable.
+ same way as it does when processing the \l {sourcedirs-variable}
+ {sourcedirs} variable. For more information, see the \l
+ {sourcedirs-variable} {sourcedirs} variable.
- See also \l sourcedirs.
+ See also \l {sourcedirs-variable} {sourcedirs}.
- \row
- \o \bold sources.fileextensions \target sources.fileextensions
- \o \bold {The \c sources.fileextensions variable filters the
- files within a source directory.}
+
+ \section1 sources.fileextensions
+ \target sources.fileextensions-variable
+
+ The \c sources.fileextensions variable filters the
+ files within a source directory.
When processing the source files specified in the \l
{sourcedirs} {\c sourcedirs} variable, QDoc will only read
@@ -7940,12 +7826,15 @@
\warning The above assignment may not work as described.
- See also \l sourcedirs and \l sources.
+ See also \l {sourcedirs-variable} {sourcedirs} and
+ \l (sources-variable} {sources}.
- \row
- \o \bold spurious \target spurious
- \o \bold {The \c spurious variable excludes specified
- QDoc warnings from the output.}
+
+ \section1 spurious
+ \target spurious-variable
+
+ The \c spurious variable excludes specified
+ QDoc warnings from the output.
The warnings are specified using standard wildcard
expressions. For example:
@@ -7964,10 +7853,11 @@
qt-4.0/src/opengl/qgl_mac.cpp:156: Missing parameter name
\endcode
- \row
- \o \bold tabsize \target tabsize
- \o \bold {The \c tabsize variable defines the size of a tab
- character.}
+
+ \section1 tabsize
+ \target tabsize-variable
+
+ The \c tabsize variable defines the size of a tab character.
For example:
@@ -7980,14 +7870,18 @@
The default value of the variable is 8, and doesn't need to
be specified.
- \row
- \o \bold tagfile \target tagfile
- \o \bold{The \c tagfile variable specifies the Doxygen tag file to be written
- when HTML is generated.}
- \row
- \o \bold version \target version
- \o \bold {The \c version variable specifies the version number of the
- documented software.}
+
+ \section1 tagfile
+ \target tagfile-variable
+
+ The \c tagfile variable specifies the Doxygen tag file to be written
+ when HTML is generated.
+
+ \section1 version
+ \target version-variable
+
+ The \c version variable specifies the version number of the
+ documented software.
For example:
@@ -8006,11 +7900,13 @@
See also \l versionsym.
- \row
- \o \bold versionsym \target versionsym
- \o \bold {The \c versionsym variable specifies a C++
- preprocessor symbol that defines the version number
- of the documented software.}
+
+ \section1 versionsym
+ \target versionsym-variable
+
+ The \c versionsym variable specifies a C++
+ preprocessor symbol that defines the version number
+ of the documented software.
For example in \l qt.qdocconf:
@@ -8034,7 +7930,7 @@
See also \l {version} {\\version}.
- \endtable
+
*/
/*!
@@ -8117,25 +8013,11 @@
The C++ specific configuration variables are provided to avoid
erroneous documentation due to non-standard C++ constructs.
- \section1 Alphabetical List
-
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
- {Cpp.ignoredirectives},
- \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
- {Cpp.ignoretokens}
-
- \section1 Variable Descriptions
-
- \table
+ \section1 Cpp.ignoredirectives
+ \target Cpp.ignoredirectives-variable
- \header
- \o Variable
- \o Description
-
- \row
- \o \bold Cpp.ignoredirectives \target Cpp.ignoredirectives
- \o \bold {The \c Cpp.ignoredirectives variable makes QDoc ignore
- the specified non-standard constructs, within C++ source code.}
+ The \c Cpp.ignoredirectives variable makes QDoc ignore
+ the specified non-standard constructs, within C++ source code.
If not specified by the \tt {\l Cpp.ignoretokens} or \tt
{\l Cpp.ignoredirectives} variables, non-standard
@@ -8188,10 +8070,12 @@
See also \l Cpp.ignoretokens.
- \row
- \o \bold Cpp.ignoretokens \target Cpp.ignoretokens
- \o \bold {The \c Cpp.ignoretokens variable makes QDoc ignore
- the specified non-standard constructs, within C++ source code.}
+
+ \section1 Cpp.ignoretokens
+ \target Cpp.ignoretokens-variable
+
+ The \c Cpp.ignoretokens variable makes QDoc ignore
+ the specified non-standard constructs, within C++ source code.
If not specified by the \tt {\l Cpp.ignoretokens} or \tt
{\l Cpp.ignoredirectives} variables, non-standard
@@ -8240,7 +8124,7 @@
See also \l Cpp.ignoredirectives.
- \endtable
+
*/
@@ -8257,27 +8141,11 @@
documentation's footer or postheader. The format of the variable
values are raw HTML.
- \section1 Alphabetical List
+ \section1 HTML.footer
+ \target HTML.footer-variable
- \l {24-qdoc-configuration-htmlvariables.html#HTML.footer} {HTML.footer},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
- {HTML.postheader},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.style} {HTML.style},
- \l {24-qdoc-configuration-htmlvariables.html#HTML.stylesheets} {HTML.stylesheets}
-
-
- \section1 Variable Descriptions
-
- \table
-
- \header
- \o Variable
- \o Description
-
- \row
- \o \bold HTML.footer \target HTML.footer
- \o \bold {The \c HTML.footer variable defines the content
- of the generated HTML documentation's footer.}
+ The \c HTML.footer variable defines the content
+ of the generated HTML documentation's footer.
The footer is rendered at the bottom of the generated
documentation page.
@@ -8299,10 +8167,12 @@
{http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
- \row
- \o \bold HTML.postheader \target HTML.postheader
- \o \bold {The \c HTML.postheader variable defines the content
- of the generated HTML documentation's postheader.}
+
+ \section1 HTML.postheader
+ \target HTML.postheader-variable
+
+ The \c HTML.postheader variable defines the content
+ of the generated HTML documentation's postheader.
The header is rendered at the top of the generated
documentation page.
@@ -8328,10 +8198,12 @@
{http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
- \row
- \o \bold HTML.style \target HTML.style
- \o \bold {The HTML.style variable defines the style for
- the generated HTML documentation.}
+
+ \section1 HTML.style
+ \target HTML.style-variable
+
+ The HTML.style variable defines the style for
+ the generated HTML documentation.
The variable's value is given as raw HTML enclosed by
quotation marks. Note that if the value spans several
@@ -8354,10 +8226,12 @@
{http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
Documentation}.
- \row
- \o \bold HTML.stylesheets \target HTML.stylesheets
- \o \bold {The HTML.stylesheets variable defines a list of stylesheets
- to use for the generated HTML documentation.}
+
+ \section1 HTML.stylesheets
+ \target HTML.stylesheets-variable
+
+ The HTML.stylesheets variable defines a list of stylesheets
+ to use for the generated HTML documentation.
Using separate stylesheets for the documentation makes it easier to
customize and experiment with the style used once the contents has
@@ -8371,51 +8245,37 @@
QDoc expects to find stylesheets in the directory containing the
\l qt.qdocconf file, and it will copy those specified to the output
directory alongside the HTML pages.
- \endtable
+
*/
/*!
\page 25-qdoc-configuration-derivedprojects.html
\previouspage HTML Specific Configuration Variables
\contentspage Table of Contents
- \nextpage QDoc Compatibility
+ \nextpage Compatibility Issues
\title Supporting Derived Projects
- \tableofcontents
-
Some particular configuration variables allow you to use QDoc to
support Qt-based projects; i.e to make projects, such as Qt Solutions,
contain references to the online Qt documentation. This
means that QDoc will be able to create links to the class reference
documentation, without any explicit linking command.
- \section1 The Configuration Variables
+ \section1 description
+ \target description-variable
- \section2 Alphabetical List
+ The description variable holds a short description of
+ the associated project.
- \l{25-qdoc-configuration-derivedprojects.html#description} {description},
- \l{25-qdoc-configuration-derivedprojects.html#indexes} {indexes},
- \l{25-qdoc-configuration-derivedprojects.html#project} {project},
- \l{25-qdoc-configuration-derivedprojects.html#url} {url}
-
- \section2 Variable Descriptions
+ See also \l project.
- \table
- \header
- \o Variable
- \o Description
- \row
- \o \bold description \target description
- \o \bold {The description variable holds a short description of
- the associated project.}
- See also \l project.
+ \section1 indexes
+ \target indexes-variable
- \row
- \o \bold indexes \target indexes
- \o \bold {The \c indexes variable lists the index files
- that will be used to generate references.}
+ The \c indexes variable lists the index files
+ that will be used to generate references.
For example. to make a derived Qt project contain links to
the Qt Reference documentation, you need to specify the
@@ -8427,13 +8287,15 @@
See also \l project and \l url.
- \row
- \o \bold project \target project
- \o \bold {The \c project variable provides a name for the project
- associated with the \c .qdocconf file.}
+
+ \section1 project
+ \target project-variable
+
+ The \c project variable provides a name for the project
+ associated with the \c .qdocconf file.
The project's name is used to form a file name for the
- associated project's \i index file. For example:
+ associated project's \e index file. For example:
\code
project = QtMotif
@@ -8443,10 +8305,12 @@
created.
See also \l description and \l indexes.
- \row
- \o \bold url \target url
- \o \bold {The \c url variable holds the base URL for the
- reference documentation associated with the current project.}
+
+ \section1 url
+ \target url-variable
+
+ The \c url variable holds the base URL for the
+ reference documentation associated with the current project.
The URL is stored in the generated index file for the
project. When we use the index on its own, QDoc will use
@@ -8469,7 +8333,7 @@
See also \l indexes.
- \endtable
+
\target howto
\section1 How to Support Derived Projects
@@ -8522,7 +8386,7 @@
The code above requires that you run QDoc from the directory that
contains this file. You need to include the compat.qdocconf
file for compatibility reasons; this is further explained in the
- \l {QDoc Compatibility} section.
+ \l {Compatibility Issues} section.
\bold {To resolve the actual links to Qt classes, the
mini-project's \c .qdocconf file needs to assign a value to the \l
@@ -8540,32 +8404,28 @@
\page 26-qdoc-commands-compatibility.html
\previouspage Supporting Derived Projects
\contentspage Table of Contents
- \nextpage QDoc Commands - Alphabetical List
-
- \title QDoc Compatibility
+ \nextpage qt.qdocconf
- \tableofcontents
+ \title Compatibility Issues
\section1 General Description
\target reason
- QDoc is a tool that constantly evolves to suit our needs, for that
- reason there are some compatibility issues in the transition
- between old and new practices.
+ Because QDoc evolves to suit our documentation needs, there can be
+ some compatibility issues when converting to a new version.
- To make the transition as smooth and rapid as possible, the
- general idea is to adopt the new commands and usage in new
- documentation. While waiting for the occurrences of the old
- practices to be eliminated from the old parts of the
- documentation, you can map the new commands and usage to the old
- ones using a compat.qdocconf file.
+ To allow you to proceed at your own speed when converting your
+ qdoc comments to use new qdoc commands and formats, the ability to
+ include a configuration file called \c {compat.qdocconf} is
+ provided.
- A compat.qdocconf file is a separate \c .qdocconf file which you
- can include in your main configuration file. It typically contains
- the mapping between old and new commands using the \l alias and \l
- {22-qdoc-configuration-generalvariables.html#macro} {macro}
- configuration variables.
+ A \c {compat.qdocconf} file is a separate configuration file,
+ which you include in your main configuration file. It typically
+ contains the mappings from old qdoc commands to new ones using
+ \l {alias} and
+ \l {22-qdoc-configuration-generalvariables.html#macro-variable}
+ {macro} configuration variables.
\section1 Qt Compatibility
@@ -8575,11 +8435,11 @@
detailed information about the commands creating compatibility
issues, see the \l {Command Comments} {command comments}.
- \section2 Qt's current compat.qdocconf file
+ \section1 Qt's current compat.qdocconf file
\quotefile files/compat.qdocconf
- \section2 Command Comments
+ \section1 Command Comments
\table
\header
@@ -8645,7 +8505,7 @@
in italic instead, we introduce the new \\o command for
this purpose.
- \bold {Use \l {o} {\\o} to indicate list and table items in
+ \bold {Use \l {o-command} {\\o} to indicate list and table items in
new documentation}.
\row
@@ -8663,118 +8523,120 @@
\o These commands are equivalent, and represent a simple name
change.
- \bold {Use \l {image} {\\image} in new documentation}.
+ \bold {Use \l {image-command} {\\image} in new documentation}.
\endtable
*/
/*!
\page 27-qdoc-commmands-alphabetical.html
- \previouspage QDoc Compatibility
+ \previouspage Introduction to QDoc
\contentspage Table of Contents
+ \nextpage Topic Commands
+
+ \title The QDoc Commands
- \title QDoc Commands - Alphabetical List
+ This is a complete, alphabetized list of the QDoc commands.
\list
- \o \l {04-qdoc-commands-textformatting.html#a} {\\a}
- \o \l {11-qdoc-commands-documentcontents.html#abstract} {\\abstract}
- \o \l {06-qdoc-commands-verbatimcode.html#badcode} {\\badcode}
- \o \l {04-qdoc-commands-textformatting.html#bold} {\\bold}
- \o \l {11-qdoc-commands-documentcontents.html#brief-command} {\\brief}
- \o \l {04-qdoc-commands-textformatting.html#c} {\\c}
- \o \l {09-qdoc-commands-graphic.html#caption} {\\caption}
- \o \l {05-qdoc-commands-documentstructuring.html#chapter} {\\chapter}
- \o \l {13-qdoc-commands-topical.html#class-command} {\\class}
- \o \l {06-qdoc-commands-verbatimcode.html#code-command} {\\code}
- \o \l {07-0-qdoc-commands-quoting.html#codeline} {\\codeline},
- \o \l {16-qdoc-commands-status.html#compat} {\\compat}
- \o \l {15-qdoc-commands-navigation.html#contentspage} {\\contentspage}
- \o \l {04-qdoc-commands-textformatting.html#div} {\\div} \span {class="newStuff"} {(new)}
- \o \l {07-0-qdoc-commands-quoting.html#dots} {\\dots}
- \o \l {12-0-qdoc-commands-miscellaneous.html#else} {\\else}
- \o \l {12-0-qdoc-commands-miscellaneous.html#endif} {\\endif}
- \o \l {13-qdoc-commands-topical.html#enum-command} {\\enum}
- \o \l {13-qdoc-commands-topical.html#example-command} {\\example}
- \o \l {12-0-qdoc-commands-miscellaneous.html#expire} {\\expire}
- \o \l {13-qdoc-commands-topical.html#externalpage} {\\externalpage}
- \o \l {13-qdoc-commands-topical.html#fn} {\\fn}
- \o \l {11-qdoc-commands-documentcontents.html#footnote} {\\footnote}
+ \o \l {04-qdoc-commands-textmarkup.html#a-command} {\\a}
+ \o \l {11-qdoc-commands-specialcontent.html#abstract-command} {\\abstract}
+ \o \l {06-qdoc-commands-includecodeinline.html#badcode-command} {\\badcode}
+ \o \l {04-qdoc-commands-textmarkup.html#bold-command} {\\bold}
+ \o \l {11-qdoc-commands-specialcontent.html#brief-command} {\\brief}
+ \o \l {04-qdoc-commands-textmarkup.html#c-command} {\\c}
+ \o \l {09-qdoc-commands-includingimages.html#caption-command} {\\caption}
+ \o \l {05-qdoc-commands-documentstructure.html#chapter-command} {\\chapter}
+ \o \l {13-qdoc-commands-topics.html#class-command} {\\class}
+ \o \l {06-qdoc-commands-includecodeinline.html#code-command} {\\code}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#codeline-command} {\\codeline},
+ \o \l {16-qdoc-commands-status.html#compat-command} {\\compat}
+ \o \l {15-qdoc-commands-navigation.html#contentspage-command} {\\contentspage}
+ \o \l {04-qdoc-commands-textmarkup.html#div-command} {\\div} \span {class="newStuff"} {(new)}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#dots-command} {\\dots}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#else-command} {\\else}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#endif-command} {\\endif}
+ \o \l {13-qdoc-commands-topics.html#enum-command} {\\enum}
+ \o \l {13-qdoc-commands-topics.html#example-command} {\\example}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#expire-command} {\\expire}
+ \o \l {13-qdoc-commands-topics.html#externalpage-command} {\\externalpage}
+ \o \l {13-qdoc-commands-topics.html#fn-command} {\\fn}
+ \o \l {11-qdoc-commands-specialcontent.html#footnote-command} {\\footnote}
\o \l {12-0-qdoc-commands-miscellaneous.html#generatelist-command} {\\generatelist}
- \o \l {13-qdoc-commands-topical.html#group-command} {\\group}
- \o \l {10-qdoc-commands-container.html#header} {\\header}
- \o \l {13-qdoc-commands-topical.html#headerfile} {\\headerfile}
- \o \l {04-qdoc-commands-textformatting.html#i} {\\i}
+ \o \l {13-qdoc-commands-topics.html#group-command} {\\group}
+ \o \l {10-qdoc-commands-tablesandlists.html#header-command} {\\header}
+ \o \l {13-qdoc-commands-topics.html#headerfile-command} {\\headerfile}
+ \o \l {04-qdoc-commands-textmarkup.html#i-command} {\\i}
\o \l {12-0-qdoc-commands-miscellaneous.html#if-command} {\\if}
- \o \l {09-qdoc-commands-graphic.html#image} {\\image}
- \o \l {12-0-qdoc-commands-miscellaneous.html#include} {\\include}
- \o \l {15-qdoc-commands-navigation.html#indexpage} {\\indexpage}
+ \o \l {09-qdoc-commands-includingimages.html#image-command} {\\image}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#include-command} {\\include}
+ \o \l {15-qdoc-commands-navigation.html#indexpage-command} {\\indexpage}
\o \l {19-qdoc-commands-grouping.html#ingroup-command} {\\ingroup}
\o \l {19-qdoc-commands-grouping.html#inmodule-command} {\\inmodule}
- \o \l {09-qdoc-commands-graphic.html#inlineimage-command} {\\inlineimage}
- \o \l {16-qdoc-commands-status.html#internal} {\\internal}
- \o \l {08-qdoc-commands-linking.html#keyword} {\\keyword}
- \o \l {08-qdoc-commands-linking.html#l} {\\l}
- \o \l {11-qdoc-commands-documentcontents.html#legalese} {\\legalese}
- \o \l {10-qdoc-commands-container.html#list} {\\list}
- \o \l {13-qdoc-commands-topical.html#macro} {\\macro}
+ \o \l {09-qdoc-commands-includingimages.html#inlineimage-command} {\\inlineimage}
+ \o \l {16-qdoc-commands-status.html#internal-command} {\\internal}
+ \o \l {08-qdoc-commands-creatinglinks.html#keyword-command} {\\keyword}
+ \o \l {08-qdoc-commands-creatinglinks.html#l-command} {\\l}
+ \o \l {11-qdoc-commands-specialcontent.html#legalese-command} {\\legalese}
+ \o \l {10-qdoc-commands-tablesandlists.html#list-command} {\\list}
+ \o \l {13-qdoc-commands-topics.html#macro-command} {\\macro}
\o \l {19-qdoc-commands-grouping.html#mainclass-command} {\\mainclass}
- \o \l {12-0-qdoc-commands-miscellaneous.html#meta} {\\meta}
- \o \l {13-qdoc-commands-topical.html#module} {\\module}
- \o \l {13-qdoc-commands-topical.html#namespace} {\\namespace}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#meta-command} {\\meta}
+ \o \l {13-qdoc-commands-topics.html#module-command} {\\module}
+ \o \l {13-qdoc-commands-topics.html#namespace-command} {\\namespace}
\o \l {15-qdoc-commands-navigation.html#nextpage-command} {\\nextpage}
- \o \l {06-qdoc-commands-verbatimcode.html#newcode} {\\newcode}
- \o \l {17-qdoc-commands-thread.html#nonreentrant} {\\nonreentrant}
- \o \l {10-qdoc-commands-container.html#o} {\\o}
- \o \l {16-qdoc-commands-status.html#obsolete} {\\obsolete}
- \o \l {06-qdoc-commands-verbatimcode.html#oldcode} {\\oldcode}
- \o \l {12-0-qdoc-commands-miscellaneous.html#omit} {\\omit}
- \o \l {10-qdoc-commands-container.html#omitvalue-command} {\\omitvalue}
- \o \l {18-qdoc-commands-relating.html#overload} {\\overload}
- \o \l {13-qdoc-commands-topical.html#page} {\\page}
- \o \l {05-qdoc-commands-documentstructuring.html#part} {\\part}
- \o \l {16-qdoc-commands-status.html#preliminary} {\\preliminary}
- \o \l {15-qdoc-commands-navigation.html#previouspage} {\\previouspage}
- \o \l {07-0-qdoc-commands-quoting.html#printline} {\\printline}
- \o \l {07-0-qdoc-commands-quoting.html#printto} {\\printto}
- \o \l {07-0-qdoc-commands-quoting.html#printuntil} {\\printuntil}
- \o \l {13-qdoc-commands-topical.html#property} {\\property}
- \o \l {11-qdoc-commands-documentcontents.html#quotation} {\\quotation}
- \o \l {07-0-qdoc-commands-quoting.html#quotefile-command} {\\quotefile}
- \o \l {07-0-qdoc-commands-quoting.html#quotefromfile-command} {\\quotefromfile}
- \o \l {12-0-qdoc-commands-miscellaneous.html#raw} {\\raw} \span {class="newStuff"} {(avoid)}
- \o \l {17-qdoc-commands-thread.html#reentrant} {\\reentrant}
- \o \l {18-qdoc-commands-relating.html#reimp} {\\reimp}
+ \o \l {06-qdoc-commands-includecodeinline.html#newcode-command} {\\newcode}
+ \o \l {17-qdoc-commands-thread.html#nonreentrant-command} {\\nonreentrant}
+ \o \l {10-qdoc-commands-tablesandlists.html#o-command} {\\o}
+ \o \l {16-qdoc-commands-status.html#obsolete-command} {\\obsolete}
+ \o \l {06-qdoc-commands-includecodeinline.html#oldcode-command} {\\oldcode}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#omit-command} {\\omit}
+ \o \l {10-qdoc-commands-tablesandlists.html#omitvalue-command} {\\omitvalue}
+ \o \l {18-qdoc-commands-relating.html#overload-command} {\\overload}
+ \o \l {13-qdoc-commands-topics.html#page-command} {\\page}
+ \o \l {05-qdoc-commands-documentstructure.html#part-command} {\\part}
+ \o \l {16-qdoc-commands-status.html#preliminary-command} {\\preliminary}
+ \o \l {15-qdoc-commands-navigation.html#previouspage-command} {\\previouspage}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printline-command} {\\printline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printto-command} {\\printto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#printuntil-command} {\\printuntil}
+ \o \l {13-qdoc-commands-topics.html#property-command} {\\property}
+ \o \l {11-qdoc-commands-specialcontent.html#quotation-command} {\\quotation}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefile-command} {\\quotefile}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command} {\\quotefromfile}
+ \o \l {12-0-qdoc-commands-miscellaneous.html#raw-command} {\\raw} \span {class="newStuff"} {(avoid)}
+ \o \l {17-qdoc-commands-thread.html#reentrant-command} {\\reentrant}
+ \o \l {18-qdoc-commands-relating.html#reimp-command} {\\reimp}
\o \l {18-qdoc-commands-relating.html#relates-command} {\\relates}
- \o \l {10-qdoc-commands-container.html#row} {\\row}
- \o \l {08-qdoc-commands-linking.html#sa} {\\sa}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionOne} {\\section1}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionTwo} {\\section2}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionThree} {\\section3}
- \o \l {05-qdoc-commands-documentstructuring.html#sectionFour} {\\section4}
- \o \l {13-qdoc-commands-topical.html#service} {\\service}
- \o \l {16-qdoc-commands-status.html#since} {\\since}
- \o \l {07-0-qdoc-commands-quoting.html#skipline} {\\skipline}
- \o \l {07-0-qdoc-commands-quoting.html#skipto} {\\skipto}
- \o \l {07-0-qdoc-commands-quoting.html#skipuntil} {\\skipuntil}
- \o \l {07-0-qdoc-commands-quoting.html#snippet} {\\snippet},
- \o \l {04-qdoc-commands-textformatting.html#span} {\\span} \span {class="newStuff"} {(new)}
- \o \l {15-qdoc-commands-navigation.html#startpage} {\\startpage}
- \o \l {04-qdoc-commands-textformatting.html#sub} {\\sub}
- \o \l {20-qdoc-commands-title.html#subtitle} {\\subtitle}
- \o \l {04-qdoc-commands-textformatting.html#sup} {\\sup}
- \o \l {10-qdoc-commands-container.html#table} {\\table}
- \o \l {11-qdoc-commands-documentcontents.html#tableofcontents}
- {\\tableofcontents}
- \o \l {08-qdoc-commands-linking.html#target} {\\target}
- \o \l {17-qdoc-commands-thread.html#threadsafe} {\\threadsafe}
- \o \l {20-qdoc-commands-title.html#title-command} {\\title}
- \o \l {04-qdoc-commands-textformatting.html#tt} {\\tt}
- \o \l {13-qdoc-commands-topical.html#typedef} {\\typedef}
- \o \l {04-qdoc-commands-textformatting.html#underline} {\\underline}
- \o \l {13-qdoc-commands-topical.html#variable} {\\variable}
- \o \l {10-qdoc-commands-container.html#value-command} {\\value}
- \o \l {11-qdoc-commands-documentcontents.html#warning} {\\warning}
+ \o \l {10-qdoc-commands-tablesandlists.html#row-command} {\\row}
+ \o \l {08-qdoc-commands-creatinglinks.html#sa-command} {\\sa}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionOne-command} {\\section1}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionTwo-command} {\\section2}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionThree-command} {\\section3}
+ \o \l {05-qdoc-commands-documentstructure.html#sectionFour-command} {\\section4}
+ \o \l {13-qdoc-commands-topics.html#service-command} {\\service}
+ \o \l {16-qdoc-commands-status.html#since-command} {\\since}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipline-command} {\\skipline}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipto-command} {\\skipto}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#skipuntil-command} {\\skipuntil}
+ \o \l {07-0-qdoc-commands-includingexternalcode.html#snippet-command} {\\snippet},
+ \o \l {04-qdoc-commands-textmarkup.html#span-command} {\\span} \span {class="newStuff"} {(new)}
+ \o \l {15-qdoc-commands-navigation.html#startpage-command} {\\startpage}
+ \o \l {04-qdoc-commands-textmarkup.html#sub-command} {\\sub}
+ \o \l {20-qdoc-commands-namingthings.html#subtitle-command} {\\subtitle}
+ \o \l {04-qdoc-commands-textmarkup.html#sup-command} {\\sup}
+ \o \l {10-qdoc-commands-tablesandlists.html#table-command} {\\table}
+ \o \l {11-qdoc-commands-specialcontent.html#tableofcontents-command} {\\tableofcontents}
+ \o \l {08-qdoc-commands-creatinglinks.html#target-command} {\\target}
+ \o \l {17-qdoc-commands-thread.html#threadsafe-command} {\\threadsafe}
+ \o \l {20-qdoc-commands-namingthings.html#title-command} {\\title}
+ \o \l {04-qdoc-commands-textmarkup.html#tt-command} {\\tt}
+ \o \l {13-qdoc-commands-topics.html#typedef-command} {\\typedef}
+ \o \l {04-qdoc-commands-textmarkup.html#underline-command} {\\underline}
+ \o \l {13-qdoc-commands-topics.html#variable-command} {\\variable}
+ \o \l {10-qdoc-commands-tablesandlists.html#value-command} {\\value}
+ \o \l {11-qdoc-commands-specialcontent.html#warning-command} {\\warning}
\endlist
*/
diff --git a/tools/qdoc3/doc/qdoc-manual.qdocconf b/tools/qdoc3/doc/qdoc-manual.qdocconf
index 84ee2ba..33e461f 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdocconf
+++ b/tools/qdoc3/doc/qdoc-manual.qdocconf
@@ -1,102 +1,30 @@
-include(../test/qt-html-default-styles.qdocconf)
+include(../test/compat.qdocconf)
include(../test/macros.qdocconf)
+include(../test/qt-cpp-ignore.qdocconf)
+include(../test/qt-defines.qdocconf)
+
+include(../test/qt-html-templates-online.qdocconf)
project = QDoc
description = QDoc3 Manual
+version = 4.7.1
indexes = ../../../doc/html/qt.index
-outputdir = html
-
-sources = qdoc-manual.qdoc
-sourcedirs = $PWD
-
-exampledirs += $PWD \
- ../../../examples
-
-imagedirs += images
-
-extraimages.HTML = qt-logo.png \
- arrow_down.png \
- breadcrumb.png \
- bullet_gt.png \
- bullet_dn.png \
- bullet_sq.png \
- bullet_up.png \
- horBar.png \
- sprites-combined.png
+sourceencoding = UTF-8
+outputencoding = UTF-8
+naturallanguage = en_US
-HTML.stylesheets = style/style.css \
- style/OfflineStyle.css \
- style/style_ie7.css \
- style/style_ie8.css \
- style/style_ie6.css
+outputdir = $PWD/doc/html
-HTML.postheader = "<div class=\"header\" id=\"qtdocheader\">\n" \
- " <div class=\"content\"> \n" \
- " <div id=\"nav-logo\">\n" \
- " <a href=\"index.html\">Home</a>\n" \
- " </div>\n" \
- " <a href=\"index.html\" class=\"qtref\"><span>QDoc User Manual</span></a>\n" \
- " </div>\n" \
- "</div>\n" \
- "<div class=\"wrap\">\n" \
- " <div class=\"toolbar\">\n" \
- " <div class=\"breadcrumb toolblock\">\n" \
- " <ul>\n" \
- " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \
- " <!-- Bread crumbs goes here -->\n"
+sources = ../doc/qdoc-manual.qdoc
+sourcedirs = $PWD/doc
-HTML.postpostheader = " </ul>\n" \
- " </div>\n" \
- " </div>\n" \
- " <div class=\"content mainContent\">\n"
-
-HTML.footer = "" \
- " </div>\n" \
- "</div>\n" \
- "<div class=\"ft\">\n" \
- " <span></span>\n" \
- "</div>\n" \
- "<div class=\"footer\">\n" \
- " <p>\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2008-2010 Nokia Corporation and/or its\n" \
- " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
- " in Finland and/or other countries worldwide.\n" \
- " </p>\n" \
- " <p>\n" \
- " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \
- " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a>\n" \
- " </p>\n" \
- " <br />\n" \
- " <p>\n" \
- " Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \
- " Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \
- " with the terms contained in a written agreement between you and Nokia.\n" \
- " </p>\n" \
- " <p>\n" \
- " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \
- " Free Documentation License version 1.3</a>\n" \
- " as published by the Free Software Foundation.\n" \
- " </p>\n" \
- "</div>\n" \
- "<div id=\"blurpage\">\n" \
- "</div>\n"
-
-# This stuff is used by the Qt 4.7 doc format.
-scriptdirs = ../../../doc/src/template/scripts
-styledirs = ../../../doc/src/template/style
-
-scripts.HTML = functions.js \
- narrow.js \
- superfish.js \
- jquery.js
-
-styles.HTML = style.css \
- narrow.css \
- superfish.css \
- superfish_skin.css \
- style_ie6.css \
- style_ie7.css \
- style_ie8.css
+exampledirs += $PWD/doc \
+ ../../../examples
+imagedirs = $QT_SOURCE_TREE/doc/src/images \
+ $QT_SOURCE_TREE/examples \
+ $QT_SOURCE_TREE/doc/src/declarative/pics \
+ $QT_SOURCE_TREE/doc/src/template/images \
+ ../doc/images
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 63e43d2..ce6bd09 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -915,9 +915,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
if (threeColumnEnumValueTable) {
out() << "<table class=\"valuelist\">";
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<th class=\"tblConst\">Constant</th>"
<< "<th class=\"tblval\">Value</th>"
@@ -1115,9 +1115,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
if (!atom->string().isEmpty())
out() << "<tr " << atom->string() << ">";
else if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
break;
case Atom::TableRowRight:
out() << "</tr>\n";
@@ -3875,9 +3875,9 @@ void HtmlGenerator::generateDetailedQmlMember(const Node *node,
if ((*p)->type() == Node::QmlProperty) {
qpn = static_cast<const QmlPropertyNode*>(*p);
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<td class=\"tblQmlPropNode\"><p>";
@@ -3902,9 +3902,9 @@ void HtmlGenerator::generateDetailedQmlMember(const Node *node,
out() << "<table class=\"qmlname\">";
//out() << "<tr>";
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<td class=\"tblQmlFuncNode\"><p>";
out() << "<a name=\"" + refForNode(qsn) + "\"></a>";
generateSynopsis(qsn,relative,marker,CodeMarker::Detailed,false);
@@ -3919,9 +3919,9 @@ void HtmlGenerator::generateDetailedQmlMember(const Node *node,
out() << "<table class=\"qmlname\">";
//out() << "<tr>";
if (++numTableRows % 2 == 1)
- out() << "<tr class=\"odd\">";
+ out() << "<tr valign=\"top\" class=\"odd\">";
else
- out() << "<tr class=\"even\">";
+ out() << "<tr valign=\"top\" class=\"even\">";
out() << "<td class=\"tblQmlFuncNode\"><p>";
out() << "<a name=\"" + refForNode(qmn) + "\"></a>";
generateSynopsis(qmn,relative,marker,CodeMarker::Detailed,false);
generated by cgit v0.12 at 2024-12-27 09:37:54 (GMT)