diff options
Diffstat (limited to 'tools/qdoc3/doc/qdoc-manual.qdoc')
| -rw-r--r-- | tools/qdoc3/doc/qdoc-manual.qdoc | 597 |
1 files changed, 280 insertions, 317 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc index ff764a0..bd3bdef 100644 --- a/tools/qdoc3/doc/qdoc-manual.qdoc +++ b/tools/qdoc3/doc/qdoc-manual.qdoc @@ -831,33 +831,32 @@ \title Document Structure - The document structuring commands divide the documentation into - sections. In total, there are six levels of sections in QDoc: \c - \part, \c \chapter, \c \section1, \c \section2, \c \section3 and - \c \section4. \c \section1 to \c \section4 correspond to the - traditional section, subsection, subsubsection and - subsubsubsection. + The document structuring commands are for dividing your document + into sections. QDoc supports six kinds of sections: \c \part, \c + \chapter, \c \section1, \c \section2, \c \section3 and \c + \section4. The \c \section1..4 commands are the most useful. The + correspond to the traditional section, subsection, etc used in + outlining. \target part-command \section1 \\part - The \\part command is intended for use in - larger documents, and divides the document into parts. + The \\part command is intended for use in a large document, like a + book. - In general a document structuring command considers - everything that follows it until the first line break as - its argument. The argument is rendered as the unit's - title. If the title needs to be spanned over several lines, - make sure that each line (except the last one) is ended - with a backslash. + In general a document structuring command considers everything + that follows it until the first line break as its argument. The + argument is rendered as the unit's title. If the title needs to be + spanned over several lines, make sure that each line (except the + last one) is ended with a backslash. - In total, there are six levels of sections in QDoc: \c - \part, \c \chapter, \c \section1, \c \section2, \c - \section3 and \c \section4. \c \section1 to \c \section4 - correspond to the traditional section, subsection, - subsubsection and subsubsubsection. + In total, there are six levels of sections in QDoc: \c \part, \c + \chapter, \c \section1, \c \section2, \c \section3 and \c + \section4. \c \section1 to \c \section4 correspond to the + traditional section, subsection, subsubsection and + subsubsubsection. - There is a strict ordering of the section units: + There is a strict ordering of the section units: \code part @@ -873,13 +872,12 @@ section4 \endcode - For example, a \c section1 unit can only appear as the top - level section or inside a \c chapter unit. Skipping a - section unit, for example from \c part to \c section1, is - not allowed. + For example, a \c section1 unit can only appear as the top level + section or inside a \c chapter unit. Skipping a section unit, for + example from \c part to \c section1, is not allowed. - You can \e begin with either of the three: \c part, \c - chapter or \c section1. For example: + You can \e begin with either of the three: \c part, \c chapter or + \c section1. For example: \code @@ -939,7 +937,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation \raw HTML @@ -1000,12 +998,9 @@ \endraw \endquotation - Each section level is a logical unit within the - document. Its title will appear in the table of contents - automatically generated by QDoc. The automatically - generated table of contents appears in the upper - righthand corner of the page. - + Each section is a logical unit in the document. The section + heading appears in the automatically generated table of contents + that normally appears in the upper righthand corner of the page. \target chapter-command \section1 \\chapter @@ -1058,44 +1053,43 @@ \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. + The following commands are used to render source code without + formatting. The source code begins on a new line, rendered in the + code. - \bold{Note:} Although all of these commands can be used to present - C++ code, the + \bold{Note:} Although all these commands are for rendering 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. + {\\codeline} commands are preferred over the others. These + commands allow equivalent code snippets for other Qt language + bindings to be substituted for the C++ snippets in the + documentation. \target code-command \section1 \\code - The \\code command and the corresponding - \\endcode command delimit a piece of verbatim 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-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 - indentation. For that reason the recommended style is to - use 8 spaces for the verbatim code contained within these - commands (note that this doesn't apply to externally - quoted code using the \l {quotefromfile-command} {\\quotefromfile} - or \l {quotefile-command} {\\quotefile} command). + The \\code and \\endcode commands enclose a snippet of source code. - For example: + \note The \l {c-command} {\\c} command can be used for short code + fragments within a sentence. The \\code command is for longer code + snippets. It renders the code verbatim in a separate paragraph in + the code font. + + When processing any of the \\code, \l {badcode-command} + {\\badcode}, \l {newcode-command} {\\newcode} or \l + {oldcode-command} {\\oldcode} commands, QDoc removes all + indentation that is common for the verbatim code blocks within a + \c{/}\c{*!} ... \c{*}\c{/} comment before it adds the standard + indentation. For that reason the recommended style is to use 8 + spaces for the verbatim code contained within these commands + + \note This doesn't apply to externally quoted code using the \l + {quotefromfile-command} {\\quotefromfile} or \l + {quotefile-command} {\\quotefile} command. + + For example: \code / *! @@ -1123,36 +1117,36 @@ } \endcode - Other QDoc commands are disabled within - \\code... \\endcode, and the special character '\\' is - accepted and rendered like the rest of the code. + Other QDoc commands are disabled within \\code... \\endcode, and + the special character '\\' is accepted and rendered like the rest + of the code. - 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-includingexternalcode.html#quotefromfile-command} {\\quotefromfile} - command instead. + To include code snippets from an external file, use the + \l{07-0-qdoc-commands-includingexternalcode.html#snippet-command} + {\\snippet} and + \l{07-0-qdoc-commands-includingexternalcode.html#codeline-command} + {\\codeline} commands. - 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}. + 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}. \target badcode-command \section1 \\badcode - 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 and \\endcode commands delimit a snippet 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 - black (the default). + The \\badcode command is similar to the \l {code-command} {\\code} + command, but it renders the code snippet using a grey font instead + of black. - Like the \l {code-command} {\\code} command, it renders its code on - a new line in the documentation using a typewriter font and - the standard indentation. For example: + Like the \l {code-command} {\\code} command, this command begins + its code snippet on a new line rendered in the code font and with + the standard indentation. For example: \code / *! @@ -1172,7 +1166,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation The statement below is rendered using the @@ -1190,32 +1184,29 @@ \endcode \endquotation - Other QDoc commands are disabled within - \\badcode... \\endcode, and the special character '\\' is - accepted and rendered like the rest of the code. - - See also \l {code-command} {\\code}, \l {newcode-command} {\\newcode} and \l - {oldcode-command} {\\oldcode}. + Other QDoc commands are disabled within \\badcode... \\endcode, + and the special character '\\' is accepted and rendered like the + rest of the code. + See also \l {code-command} {\\code}, \l {newcode-command} + {\\newcode} and \l {oldcode-command} {\\oldcode}. \target newcode-command \section1 \\newcode - 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, \\oldcode, and \\endcode commands enable you to + show how to port a snippet 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-command} {\\badcode} commands: The - combination provides a text relating the two code snippets - to each other. The command requires a preceding \\oldcode - statement. + The \\newcode command, and its companion the \\oldcode command, is + a convenience combination of the \l {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-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: + 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: \code / *! @@ -1230,7 +1221,7 @@ * / \endcode - is rendered like this: + QDoc renders this as: \quotation \oldcode @@ -1243,10 +1234,8 @@ \endcode \endquotation - Other QDoc commands are disabled within - \\oldcode ... \\endcode, and the '\\' character doesn't need - to be escaped. - + Other QDoc commands are disabled within \\oldcode ... \\endcode, + and the '\\' character doesn't need to be escaped. \target oldcode-command \section1 \\oldcode @@ -1266,34 +1255,34 @@ \title Including External Code - The following commands enable quoting from files in the - documentation: You can make QDoc include the complete contents of + The following commands enable you to include code snippets from + external files. You can make QDoc include the complete contents of a file, or you can quote specific parts of the file and skip others. The typical use of the latter is to quote a file chunk by chunk. - \bold{Note:} Although all of these commands can be used to present - C++ code, the \l{#snippet} {\\snippet} and \l{#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 - place of the C++ ones. + \bold{Note:} Although all these commands are for rendering 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 are preferred over the others. These + commands allow equivalent code snippets for other Qt language + bindings to be substituted for the C++ snippets in the + documentation. \target quotefile-command \section1 \\quotefile - 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 - break. + The command considers the rest of the line as part of its + argument, make sure to follow the file name with a line break. - The file's contents is rendered in a separate paragraph, - using a typewriter font and the standard indentation. The - code is shown verbatim. - - For example: + The file's contents is rendered in a separate paragraph, using a + typewriter font and the standard indentation. The code is shown + verbatim. For example: \code / *! @@ -1306,7 +1295,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation This is a simple "Hello world" example: @@ -1317,30 +1306,29 @@ application up and running. \endquotation - \warning If you use the \l {Compatibility Issues} - {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}. + See also \l {quotefromfile-command} {\\quotefromfile} and + \l {code-command} {\\code}. \target quotefromfile-command \section1 \\quotefromfile - The \\quotefromfile command opens the file - given as argument for quoting. + 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 - break. + The command considers the rest of the line as part of its + argument, make sure to follow the file name with a line break. - The command is intended for use when quoting parts from - file with the walkthrough commands: \l - {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: + The command is intended for use when quoting parts from file with + the walkthrough commands: \l {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: \code / *! @@ -1365,7 +1353,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation The whole application is contained within @@ -1388,40 +1376,35 @@ ... \endquotation - (\l {Example File} {The complete example file...}) - - QDoc remembers which file it's quoting, and the current - position within that file (see \l {file} {\\printline} for - more information). There is no need to "close" the file. + (\l {Example File} {The complete example file...}) - Earlier we called this command \\quotefile. For more - information, see the \l - {26-qdoc-commands-compatibility.html#quotefromfile-versus-quotefile} - {compatibility} section. + QDoc remembers which file it's quoting, and the current position + within that file (see \l {file} {\\printline} for more + information). There is no need to "close" the file. - See also \l {quotefile-command} {\\quotefile}, \l - {code-command} {\\code} and \l {dots} {\\dots}. + Earlier we called this command \\quotefile. For more information, + see the \l + {26-qdoc-commands-compatibility.html#quotefromfile-versus-quotefile} + {compatibility} section. + See also \l {quotefile-command} {\\quotefile}, \l {code-command} + {\\code} and \l {dots} {\\dots}. \target printline-command \section1 \\printline - 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 - specified as an argument to the command. Note that the - command considers the rest of the line as part of its - argument, make sure to follow the substring with a line - break. + The \\printline command expands to the line from the current + position to the next non-blank line of the current souce file. - The line from the source file is rendered as a separate - paragraph, using a typewriter font and the standard - indentation. The code is shown verbatim. + To ensure that the documentation remains synchronized with the + source file, a substring of the line must be specified as an + argument to the command. Note that the command considers the rest + of the line as part of its argument, make sure to follow the + substring with a line break. - For example: + The line from the source file is rendered as a separate paragraph, + using a typewriter font and the standard indentation. The code is + shown verbatim. For example: \code / *! @@ -1449,7 +1432,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation There has to be exactly one QApplication object @@ -1476,22 +1459,20 @@ The main function... \endquotation - (\l {Example File} {The complete example file...}) + (\l {Example File} {The complete example file...}) - \target file + \target file - QDoc reads the file sequentially. To move the current - position forward you can use either of the \l - {skipline-command} {\\skip...} commands. To move the current - position backward, you can use the \l - {quotefromfile-command} {\\quotefromfile} command again. + QDoc reads the file sequentially. To move the current position + forward you can use either of the \l {skipline-command} + {\\skip...} commands. To move the current position backward, you + can use the \l {quotefromfile-command} {\\quotefromfile} command + again. - \target substring + \target substring - If the substring argument is surrounded by slashes it is - interpreted as a \l {regular expression}. - - For example: + If the substring argument is surrounded by slashes it is + interpreted as a \l {regular expression}. For example: \code / *! @@ -1508,7 +1489,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation \quotefromfile widgets/scribble/mainwindow.cpp @@ -1523,41 +1504,36 @@ application. \endquotation - (\l {widgets/scribble} {The complete example file...}) + (\l {widgets/scribble} {The complete example file...}) - The regular expression \c /^\}/ makes QDoc print until the - first '}' character occurring at the beginning of the line - without indentation. /.../ encloses the regular expression, - and '^' means the beginning of the line. The '}' character - must be escaped since it is a special character in regular - expressions. + The regular expression \c /^\}/ makes QDoc print until the first + '}' character occurring at the beginning of the line without + indentation. /.../ encloses the regular expression, and '^' means + the beginning of the line. The '}' character must be escaped since + it is a special character in regular expressions. - QDoc will emit a warning if the specified substring or - regular expression cannot be located, i.e. if the source - code has changed. - - See also \l {printto-command} {\\printto} and \l - {printuntil-command} {\\printuntil}. + QDoc will emit a warning if the specified substring or regular + expression cannot be located, i.e. if the source code has changed. + See also \l {printto-command} {\\printto} and \l + {printuntil-command} {\\printuntil}. \target printto-command \section1 \\printto - 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-command} {\\printline} 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 lines from the source file are rendered in a separate - paragraph, using a typewriter font and the standard - indentation. The code is shown verbatim. + 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-command} {\\printline} command. - For example: + The lines from the source file are rendered in a separate + paragraph, using a typewriter font and the standard + indentation. The code is shown verbatim. For example: \code / *! @@ -1572,7 +1548,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation The whole application is contained within the @@ -1586,30 +1562,27 @@ and \c argv parameters... \endquotation - (\l {Example File} {The complete example file...}) - - See also \l {printline-command} {\\printline} and \l - {printuntil-command} {\\printuntil}. + (\l {Example File} {The complete example file...}) + See also \l {printline-command} {\\printline} and \l + {printuntil-command} {\\printuntil}. \target printuntil-command \section1 \\printuntil - 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-command} {\\printline} 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 lines from the source file are rendered in a separate - paragraph, using a typewriter font and the standard - indentation. The code is shown verbatim. + 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-command} {\\printline} command. - For example: + The lines from the source file are rendered in a separate + paragraph, using a typewriter font and the standard + indentation. The code is shown verbatim. For example: \code / *! @@ -1626,7 +1599,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation The whole application is contained within the @@ -1643,29 +1616,27 @@ {http://qt.nokia.com/doc/4.0/qpushbutton} {QPushButton}. \endquotation - (\l {Example File} {The complete example file...}) - - See also \l {printline-command} {\\printline} and \l - {printto-command} {\\printto}. + (\l {Example File} {The complete example file...}) + See also \l {printline-command} {\\printline} and \l + {printto-command} {\\printto}. \target skipline-command \section1 \\skipline - The \\skipline command ignores the next non-blank - line in the current source file. + 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 - the source file). See the remark about \l {file} {file - positioning} above. + Doc reads the file sequentially, and the \\skipline command is + used to move the current position (omitting a line of the source + file). See the remark about \l {file} {file positioning} above. - 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-command} {\\printline} - command, and it is used in conjunction with the \l - {quotefromfile-command} {\\quotefromfile} command. For example: + 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-command} {\\printline} command, + and it is used in conjunction with the \l {quotefromfile-command} + {\\quotefromfile} command. For example: \code / *! @@ -1683,7 +1654,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation \l @@ -1701,32 +1672,30 @@ that contains its definition. \endquotation - (\l {Example File} {The complete example file...}) - - See also \l {skipto-command} {\\skipto}, \l - {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}. + (\l {Example File} {The complete example file...}) + See also \l {skipto-command} {\\skipto}, \l {skipuntil-command} + {\\skipuntil} and \l {dots} {\\dots}. \target skipto-command \section1 \\skipto - The \\skipto command ignores all the lines from the - current position up to and \e excluding the next line - containing a given substring. + 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 - several lines of the source file). See the remark about \l - {file} {file positioning} above. + QDoc reads the file sequentially, and the \\skipto command is used + to move the current position (omitting one or several lines of the + source file). See the remark about \l {file} {file positioning} + above. - 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 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-command} {\\printline} - command, and it is used in conjunction with the \l - {quotefromfile-command} {\\quotefromfile} command. For example: + The command also follows the same conventions for \l {substring} + {argument} as the \l {printline-command} {\\printline} command, + and it is used in conjunction with the \l {quotefromfile-command} + {\\quotefromfile} command. For example: \code / *! @@ -1745,7 +1714,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation The whole application is contained within @@ -1761,32 +1730,30 @@ reasonable size ... \endquotation - (\l {Example File} {The complete example file...}) - - See also \l {skipline-command} {\\skipline}, \l - {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}. + (\l {Example File} {The complete example file...}) + See also \l {skipline-command} {\\skipline}, \l + {skipuntil-command} {\\skipuntil} and \l {dots} {\\dots}. \target skipuntil-command \section1 \\skipuntil - The \\skipuntil command ignores all the lines from - the current position up to and \e including the next line - containing a given substring. + 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 - or several lines of the source file). See the remark about - \l {file} {file positioning} above. + QDoc reads the file sequentially, and the \\skipuntil command is + used to move the current position (omitting one or several lines + of the source file). See the remark about \l {file} {file + positioning} above. - 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 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-command} {\\printline} - command, and it is used in conjunction with the \l - {quotefromfile-command} {\\quotefromfile} command. For example: + The command also follows the same conventions for \l {substring} + {argument} as the \l {printline-command} {\\printline} command, + and it is used in conjunction with the \l {quotefromfile-command} + {\\quotefromfile} command. For example: \code / *! @@ -1804,7 +1771,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotation The first thing we did in the \c main() function was to @@ -1820,22 +1787,21 @@ will return when the application exits... \endquotation - (\l {Example File} {The complete example file...}) - - See also \l {skipline-command} {\\skipline}, \l {skipto-command} {\\skipto} - and \l {dots} {\\dots}. + (\l {Example File} {The complete example file...}) + See also \l {skipline-command} {\\skipline}, \l {skipto-command} + {\\skipto} and \l {dots} {\\dots}. \target dots-command \section1 \\dots - The \\dots command indicates that parts of the - source file have been omitted when quoting a file. + 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 - stated on its own line. The dots are rendered on a new - line, using a typewriter font. For example: + The command is used in conjunction with the \l + {quotefromfile-command} {\\quotefromfile} command, and should be + stated on its own line. The dots are rendered on a new line, using + a typewriter font. For example: \code / *! @@ -1848,7 +1814,7 @@ * / \endcode - QDoc renders this as: + QDoc renders this as: \quotefromfile examples/main.cpp \skipto main @@ -1857,34 +1823,31 @@ \skipuntil exec \printline } - (\l {Example File} {The complete example file...}) + (\l {Example File} {The complete example file...}) - The default indentation is 4 spaces, but this can be - adjusted using the command's optional argument. For - example: + The default indentation is 4 spaces, but this can be adjusted + using the command's optional argument. For example: - \code - / *! - \dots 0 - \dots - \dots 8 - \dots 12 - \dots 16 - * / - \endcode - - QDoc renders this as: + \code + / *! + \dots 0 + \dots + \dots 8 + \dots 12 + \dots 16 + * / + \endcode - \dots 0 - \dots - \dots 8 - \dots 12 - \dots 16 + QDoc renders this as: - See also \l {skipline-command} {\\skipline}, \l - {skipto-command} {\\skipto} and \l {skipuntil-command} - {\\skipuntil}. + \dots 0 + \dots + \dots 8 + \dots 12 + \dots 16 + See also \l {skipline-command} {\\skipline}, \l {skipto-command} + {\\skipto} and \l {skipuntil-command} {\\skipuntil}. \target snippet-command \section1 \\snippet |