From f65e8376f14a189675c225cfb562df985babe544 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Thu, 24 Feb 2011 13:55:06 +0100 Subject: qdoc: More updating command descriptions. --- tools/qdoc3/doc/qdoc-manual.qdoc | 284 ++++++++++++++++----------------------- 1 file changed, 115 insertions(+), 169 deletions(-) diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc index 49163ab..faabe2c 100644 --- a/tools/qdoc3/doc/qdoc-manual.qdoc +++ b/tools/qdoc3/doc/qdoc-manual.qdoc @@ -274,7 +274,7 @@ is misspelled, so when you document a function you should mention each formal parameter by name in the function description, preceded by the \\a command. The parameter name is then rendered - in italics. For example: + in italics. \code / *! @@ -616,8 +616,6 @@ The \\bold command renders its argument in bold font. - For example: - \code / *! This is regular text; \bold {this text is @@ -737,8 +735,6 @@ The \\sub command renders its argument lower than the baseline of the regular text, using a smaller font. - For example: - \code / *! Definition (Range): Consider the sequence @@ -770,8 +766,6 @@ The \\sup command renders its argument higher than the baseline of the regular text, using a smaller font. - For example: - \code / *! The series @@ -800,8 +794,6 @@ The \\underline command renders its argument underlined. - For example: - \code / *! The \underline {F}ile menu gives the users the possibility @@ -829,7 +821,7 @@ 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: + forth. \code / *! @@ -926,7 +918,7 @@ 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: + \c section1. \code @@ -1138,8 +1130,6 @@ {quotefromfile-command} {\\quotefromfile} or \l {quotefile-command} {\\quotefile} command. - For example: - \code / *! \code @@ -1195,7 +1185,7 @@ 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: + the standard indentation. \code / *! @@ -1255,7 +1245,7 @@ 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: + standard indentation. \code / *! @@ -1331,7 +1321,7 @@ 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: + verbatim. \code / *! @@ -1377,7 +1367,7 @@ {\\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: + file. \code / *! @@ -1453,7 +1443,7 @@ 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: + shown verbatim. \code / *! @@ -1521,7 +1511,7 @@ \target substring If the substring argument is surrounded by slashes it is - interpreted as a \l {regular expression}. For example: + interpreted as a \l {regular expression}. \code / *! @@ -1582,7 +1572,7 @@ 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: + indentation. The code is shown verbatim. \code / *! @@ -1631,7 +1621,7 @@ 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: + indentation. The code is shown verbatim. \code / *! @@ -1685,7 +1675,7 @@ 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: + {\\quotefromfile} command. \code / *! @@ -1744,7 +1734,7 @@ 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: + {\\quotefromfile} command. \code / *! @@ -1802,7 +1792,7 @@ 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: + {\\quotefromfile} command. \code / *! @@ -1850,7 +1840,7 @@ 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: + a typewriter font. \code / *! @@ -1875,7 +1865,7 @@ (\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: + using the command's optional argument. \code / *! @@ -1967,14 +1957,12 @@ \section1 \\l (link) The \\l link command is used to create a hyperlink to many - different kinds of targets. The command's general syntax is + different kinds of targets. The command's general syntax is: \code \l {link target} {link text} \endcode - For example: - \code / *! Read the \l {http://qt.nokia.com/doc/4.0/} @@ -2118,7 +2106,7 @@ \endlist The \\sa command supports the same kind of links as the \l - {l-command} {\\l} command. For example: + {l-command} {\\l} command. \code / *! @@ -2162,8 +2150,6 @@ required around the target name, but they may be required when the target name is used in a link cammand. See below. - For example: - \code / *! \target capturing parentheses @@ -2205,7 +2191,7 @@ The \\keyword command is like the \l {target-command} {\\target} command, but stronger. A keyword can be linked from anywhere using - a simple syntax. For example: + a simple syntax. Keywords must be unique over all the documents processed during the QDoc run. The command uses the rest of the line as its @@ -2289,8 +2275,6 @@ description with a line break. Curly brackets are required if the description argument spans multiple lines. - For example: - \code / *! Qt by Trolltech is a C++ toolkit for cross-platform GUI @@ -2396,7 +2380,7 @@ \endraw The command can also be used to insert an image inline with the - text. For example: + text. \code / *! @@ -2500,7 +2484,7 @@ \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: + with a special formatting. \code / *! @@ -2629,7 +2613,7 @@ cells. A cell is created with the \l {o-command} {\\o} command. A header cell's text is centered within the table cell and - rendered using a bold font. For example: + rendered using a bold font. \code / *! @@ -2681,7 +2665,7 @@ The background cell color of each row alternates between two shades of grey, making it easier to distinguish the rows from each - other. The cells' contents is left aligned. For example: + other. The cells' contents is left aligned. \code / *! @@ -2824,7 +2808,7 @@ \endlist The \\list command takes an optional argument providing - alternative appearances for the list items. For example: + alternative appearances for the list items. \code / *! @@ -2931,7 +2915,7 @@ {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 example: + how many rows or columns the item should span. \code / *! @@ -3177,7 +3161,7 @@ \endcode \warning The brief statement is used as the first paragraph of the - detailed description. Do not repeat the sentence. For example: + detailed description. Do not repeat the sentence. \code / *! @@ -3400,7 +3384,7 @@ \section1 \\warning The \\warning command prepends "Warning:" to the command's - argument, in bold font. For example: + argument, in bold font. \code / *! @@ -3741,7 +3725,7 @@ 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: + statement. \code / *! @@ -3795,7 +3779,7 @@ The \\else command can only be used within \l {if-command} {\\if...\\endif} commands, but is useful when there is only two - alternatives. For example: + alternatives. \code / *! @@ -3906,7 +3890,7 @@ the enclosing \c{/}\c{*!} ... \c{*}\c{/} marks. To ensure that QDoc won't attempt to read the file as a stand-alone piece of documentation, we recommend that you use the \c .qdocinc - extension. For example: + extension. \code / *! @@ -3943,7 +3927,7 @@ The command accepts two arguments: The first argument (the 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 \e contents variable. For example: + equivalent to the tag's \e contents variable. \code / *! @@ -4042,11 +4026,11 @@ currently the only supported format is HTML. The \\raw command is useful if you want some special HTML effects - in your documentation. For example: + in your documentation. \code / *! - Qt has some predefined QColor objects. For example: + Qt has some predefined QColor objects. \raw HTML