Qt Developer Guide
Qt is a cross-platform application and UI framework. Using Qt, you can write web-enabled applications once and deploy them across desktop, mobile and embedded operating systems without rewriting the source code.
| QDoc Syntax | Generated Documentation | |
|---|---|---|
| 1 | A variation of a command button is a \e menu button. | A variation of a command button is a menu button. |
| 2 | The QPushButton widget provides a \e {command button}. | The QPushButton widget provides a command button. |
| 3 | Another class of buttons are option buttons \e (see QRadioButton). | Another class of buttons are option buttons (see QRadioButton). |
| 4 | A push button emits the signal \e clicked(). | A push button emits the signal clicked(). |
| 5 | The \e QPushButton's checked property is false by default. | The QPushButton's checked property is false by default. |
This is the first part.
This is the first chapter's first section.
This is the first chapter's second section.
This is the first chapter's third section.
This is the first part's second chapter.
This is the second chapter's first section.
...This is the second part.
This is the second part's first chapter.
This is the first chapter's first section.
... \endraw \endquotation 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 right-hand corner of the page. \target chapter-command \section1 \\chapter 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. \target sectionOne-command \section1 \\section1 The \\section1 command starts a new section. See \l{part} {\\part} for an explanation of the various section units, command argument, and rendering. \target sectionTwo-command \section1 \\section2 The \\section2 command starts a new section. See \l{part} {\\part} for an explanation of the various section units, command argument, and rendering. \target sectionThree-command \section1 \\section3 The \\section3 command starts a new section. See \l{part} {\\part} for an explanation of the various section units, command argument, and rendering. \target sectionFour-command \section1 \\section4 The \\section4 command starts a new section. See \l{part} {\\part} for an explanation of the various section units, command argument, and rendering. */ /*! \page 06-qdoc-commands-includecodeinline.html \previouspage Document Structure \contentspage QDoc Manual \nextpage Including External Code \title Including Code Inline The following commands are used to render source code without formatting. The source code begins on a new line, rendered in the code. \b{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 code-command \section1 \\code The \\code and \\endcode commands enclose a snippet of source code. \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 {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. \code / *! \code #include| Qt | Qt Creator |
|---|---|
|
|
|
|
|
| Qt Core Feature | Brief Description |
|---|---|
| Signals and Slots | Signals and slots are used for communication between objects. |
| Layout Management | The Qt layout system provides a simple and powerful way of specifying the layout of child widgets. |
| Drag and Drop | Drag and drop provides a simple visual mechanism which users can use to transfer information between and within applications. |
| This header cell spans three columns, but only one row. | ||
|---|---|---|
| This table cell spans two columns, but only one row. | This table cell spans only one column, but two rows. | |
| A regular table cell | A regular table cell | |
| Qt Core Feature | Brief Description |
|---|---|
| Signals and Slots | Signals and slots are used for communication between objects. |
| Qt Core Feature | Brief Description |
|---|---|
| Signals and Slots | Signals and slots are used for communication between objects. |
| Layout Management | The Qt layout system provides a simple and powerful way of specifying the layout of child widgets. |
| Drag and Drop | Drag and drop provides a simple visual mechanism which users can use to transfer information between and within applications. |
| This header cell spans three columns, but only one row. | ||
|---|---|---|
| This table item spans two columns, but only one row. | This table item spans only one column, but two rows. | |
| A regular table item | A regular table item | |
} and \b{} in the html output, e.g.: \code / *! Although 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 The text in the \b{\\quotation} block will appear in the generated HTML as: \code
\endcode The built-in style sheet for most browsers will render the contents of theAs our solutions were being adopted into new environments, we saw an escalating need for easier integration with a wider range of enterprise applications.
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 But you can redefine the \b{} tag in your style.css file. \target footnote-command \section1 \\footnote The \\footnote and \\endfootnote commands delimit a footnote. The footnote is rendered at the bottom of the page. \warning The \b{\\footnote} and \b{\\endfootnote} commands have not been implemented. The footnote is rendered as a regular HTML paragraph. \target note-command \section1 \\note The \\note command defines a new paragraph preceded by "Note:" in bold. \target tableofcontents-command \section1 \\tableofcontents 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. \target brief-command \section1 \\brief 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 {generatelist-command} {\\generatelist} command and the \l {annotatedlist-command} {\\annotatedlist} command. The \\brief command can be used in two significant different ways: \l {brief class} {One for classes, namespaces and header files}, and \l {brief-property} {one for properties and variables}. \target brief-property When the \\brief command is used to describe a property or 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: \code / *! \property QWidget::isActiveWindow \brief Whether this widget's window is the active window The active window is the window that contains the widget that has keyboard focus. When popup windows are visible, this property is \c true for both the active window \e and the popup. \sa activateWindow(), QApplication::activeWindow() * / \endcode and the QWidget::geometry property \code / *! \property QWidget::geometry \brief The geometry of the widget relative to its parent and excluding the window frame When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. ... \sa frameGeometry(), rect(), ... * / \endcode QDoc renders this as: \quotation \raw HTMLgeometry : QRect
\endraw This property holds the geometry of the widget relative to its parent and excluding the window frame. ... Access functions: \list \li \b {const QRect & geometry () const} \li \b {void setGeometry ( int x, int y, int w, int h )} \li \b {void setGeometry ( const QRect & )} \endlist See also \l {QWidget::frameGeometry()} {frameGeometry()}, \l {QWidget::rect()} {rect()}, ... \endquotation \target brief class When the \\brief command is used to describe a class, we recommend using a complete sentence like this: \code Theclass is|provides|contains|specifies... \endcode \warning Do not repeat your detailed description with the same sentence as the brief statement will be the first paragraph of the detailed description. \code / *! \class PreviewWindow \brief The PreviewWindow class is a custom widget displaying the names of its currently set window flags in a read-only text editor. The PreviewWindow class inherits QWidget. The widget displays the names of its window flags set with the setWindowFlags() function. It is also provided with a QPushButton that closes the window. ... \sa QWidget * / \endcode QDoc renders this as: \quotation \raw HTML PreviewWindow Class Reference
\endraw The PreviewWindow class is a custom widget displaying the names of its currently set window flags in a read-only text editor. \l {preview window} {More...} \raw HTMLProperties
\endraw \list \li 52 properties inherited from QWidget \li 1 property inherited from QObject \endlist \raw HTMLPublic Functions
\endraw \list \li \l {constructor} {PreviewWindow}(QWidget *parent = 0) \li void \l {function} {setWindowFlags}(Qt::WindowFlags flags) \endlist \list \li 183 public functions inherited from QWidget \li 28 public functions inherited from QObject \endlist \raw HTMLPublic Slots
\endraw \list \li 17 public slots inherited from QWidget \li 1 public slot inherited from QObject \endlist \raw HTMLAdditional Inherited Members
\endraw \list \li 1 signal inherited from QWidget \li 1 signal inherited from QObject \li 4 static public members inherited from QWidget \li 4 static public members inherited from QObject \li 39 protected functions inherited from QWidget \li 7 protected functions inherited from QObject \endlist \target preview window \raw HTML
Detailed Description
\endraw The PreviewWindow class is a custom widget displaying the names of its currently set window flags in a read-only text editor. The PreviewWindow class inherits QWidget. The widget displays the names of its window flags set with the \l {function} {setWindowFlags()} function. It is also provided with a QPushButton that closes the window. ... See also QWidget. \raw HTML
Member Function Documentation
\endraw \target constructor \raw HTMLPreviewWindow(QWidget *parent = 0)
\endraw Constructs a preview window widget with \e parent. \target function \raw HTMLsetWindowFlags(Qt::WindowFlags flags)
\endraw Sets the widgets flags using the QWidget::setWindowFlags() function. Then runs through the available window flags, creating a text that contains the names of the flags that matches the flags parameter, displaying the text in the widgets text editor. \endquotation Using \\brief in a \l{namespace-command}{\\namespace}: \code / *! \namespace Qt \brief The Qt namespace contains miscellaneous identifiers used throughout the Qt library. * / \endcode Using \\brief in a \l{headerfile-command}{\\headerfile}: \code / *! \headerfile\title Global Qt Declarations \brief The header file provides basic declarations and is included by all other Qt headers. \sa * / \endcode See also \l{property-command} {\\property}, \l{class-command} {\\class}, \l{namespace-command} {\\namespace} and \l{headerfile-command} {\\headerfile}. \target legalese-command \section1 \\legalese The \\legalese and \\endlegalese commands delimit a license agreement. In the generated HTML, the delimited text is surrounded by a \b { } and \b {} tags. An example of a license agreement enclosed in \\legalese and \\endlegalese: \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 It will appear in the generated HTML as: \code\endcode If the \\endlegalese command is omitted, QDoc will 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. \target warning-command \section1 \\warning The \\warning command prepends "Warning:" to the command's argument, in bold font. \code / *! Qt::HANDLE is a platform-specific handle type for system objects. This is equivalent to \c{void *} on Windows and Mac OS X, and to \c{unsigned long} on X11. \warning Using this type is not portable. * / \endcode QDoc renders this as: \quotation Qt::HANDLE is a platform-specific handle type for system objects. This is equivalent to \c{void *} on Windows and Mac OS X, and to \c{unsigned long} on X11. \warning Using this type is not portable. \endquotation */ /*! \page 12-0-qdoc-commands-miscellaneous.html \previouspage Special Content \contentspage QDoc Manual \nextpage Creating DITA Maps \title Miscellaneous These commands provide miscellaneous functions connected to the visual appearance of the documentation, and to the process of generating the documentation. \target annotatedlist-command \section1 \\annotatedlist The \\annotatedlist command expands to a list of the members of a group, each member listed with its \e {brief} text. Below is an example from the Qt Reference Documentation: \code / *! ... \section1 Drag and Drop Classes These classes deal with drag and drop and the necessary mime type encoding and decoding. \annotatedlist draganddrop * / \endcode This generates a list of all the C++ classes and/or QML types in the \e{draganddrop} group. A C++ class or QML type in the \e{draganddrop} group will have \e{\\ingroup draganddrop} in its \e{\\class} or \e{\\qmltype} comment. \target generatelist-command \section1 \\generatelist The \\generatelist command expands to a list of links to the documentation entities in a group. Below is an example from the Qt Reference Documentation: \code / *! \page classes.html \title All Classes For a shorter list that only includes the most frequently used classes, see \l{Qt's Main Classes}. \generatelist classes Q * / \endcode This generates the \e {All Classes} page. The command accepts the following arguments: \target table example \section2 \c annotatedclasses The \c annotatedclasses argument provides a table containing the names of all the classes, and a description of each class. Each class name is a link to the class's reference documentation. For example: \table \row \li QDial \li Rounded range control (like a speedometer or potentiometer) \row \li QDialog \li The base class of dialog windows \row \li QDir \li Access to directory structures and their contents \endtable A C++ class is documented with the \l {class-command} {\\class} command. The annotation for the class is taken from the argument of the class comment's \l {brief-command} {\\brief} command. \target list example \section2 \c {classesCopyright 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.
} The \c classes argument provides a complete alphabetical list of the classes. The second argument, \c{ }, is the common prefix for the class names. The class names will be sorted on the character that follows the common prefix. e.g. The common prefix for the Qt classes is \c Q. The common prefix argument is optional. If no common prefix is provided, the class names will be sorted on their first character. Each class name becomes a link to the class's reference documentation. This command is used to generate the \e {All Classes} page this way: \code / *! \page classes.html \title All Classes \ingroup classlists \brief Alphabetical list of classes. This is a list of all Qt classes. For a list of the classes provided for compatibility with Qt3, see \l{Qt3 Support Classes}. For classes that have been deprecated, see the \l{Obsolete Classes} list. \generatelist classes Q * / \endcode A C++ class is documented with the \l {class-command} {\\class} command. \section2 \c classesbymodule When this argument is used, a second argument is required, which specifies the module whose classes are to be listed. QDoc generates a table containing those classes. Each class is listed with the text of its \l{brief-command} {\\brief} command. For example, this command can be used on a module page as follows: \code / *! \page phonon-module.html \module Phonon \title Phonon Module \ingroup modules \brief Contains namespaces and classes for multimedia functionality. \generatelist{classesbymodule Phonon} ... * / \endcode Each class that is a member of the specified module must be marked with the \l {inmodule-command} {\\inmodule} command in its \\class comment. \section2 \c compatclasses The \c compatclasses argument generates a list in alphabetical order of the support classes. It is normally used only to generate the Qt3 Support Classes page this way: \code / *! \page compatclasses.html \title Qt3 Support Classes \ingroup classlists \brief Enable porting of code from Qt 3 to Qt 4. These are the classes that Qt provides for compatibility with Qt 3. Most of these are provided by the Qt3Support module. \generatelist compatclasses * / \endcode A support class is identified in the \\class comment with the \l {compat-command} {\\compat} command. \section2 \c functionindex The \c functionindex argument provides a complete alphabetical list of all the documented member functions. It is normally used only to generate the \e {Qt function index} page this way: \code / *! \page functions.html \title All Functions \ingroup funclists \brief All documented Qt functions listed alphabetically with a link to where each one is declared. This is the list of all documented member functions and global functions in the Qt API. Each function has a link to the class or header file where it is declared and documented. \generatelist functionindex * / \endcode \section2 \c legalese The \c legalese argument tells QDoc to generate a complete list of licenses in the documentation. Each license is identified using the \l {legalese-command} {\\legalese} command. This command is used to generate the \e {Qt license information} page this way: \code / *! \page licenses.html \title Other Licenses Used in Qt \ingroup licensing \brief Information about other licenses used for Qt components and third-party code. Qt contains some code that is not provided under the \l{GNU General Public License (GPL)}, \l{GNU Lesser General Public License (LGPL)} or the \l{Qt Commercial Edition}{Qt Commercial License Agreement}, but rather under specific licenses from the original authors. Some pieces of code were developed by Digia and others originated from third parties. This page lists the licenses used, names the authors, and links to the places where it is used. Digia gratefully acknowledges these and other contributions to Qt. We recommend that programs that use Qt also acknowledge these contributions, and quote these license statements in an appendix to the documentation. See also: \l{Licenses for Fonts Used in Qt for Embedded Linux} \generatelist legalese * / \endcode \section2 \c mainclasses The \c mainclasses argument tells QDoc to generate an alphabetical list of the main classes. A class is marked as a main class by including a \l {mainclass-command} {\\mainclass} command in the \\class comment. \note The Qt documentation no longer includes a main classes page, but you can generate one for your main classes if you want it. \section2 \c overviews The \c overviews argument is used to tell QDoc to generate a list by concatenating the contents of all the \l {group-command} {\\group} pages. Qt uses it to generate the \e {overviews} page this way: \code / *! \page overviews.html \title All Overviews and HOWTOs \generatelist overviews * / \endcode \section2 \c related The \c related argument is used in combination with the \l {group-command} {\\group} and \l {ingroup-command} {\\ingroup} commands to list all the overviews related to a specified group. For example, the page for the \e {Programming with Qt} page is generated this way: \code / *! \group qt-basic-concepts \title Programming with Qt \brief The basic architecture of the Qt cross-platform application and UI framework. Qt is a cross-platform application and UI framework for writing web-enabled applications for desktop, mobile, and embedded operating systems. This page contains links to articles and overviews explaining key components and techniuqes used in Qt development. \generatelist {related} * / \endcode Each page listed on this group page contains the command: \code \ingroup qt-basic-concepts \endcode \section2 \c service The \c service argument tells QDoc to generate an alphabetical list of the services. Each service name is a link to the service's reference documentation. A service is identified with the \l {service-command} {\\service} command. \note This command and the \l {service-command} {\\service} command are not used in the Qt documentation. \target if-command \section1 \\if 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. \code / *! \if defined(opensourceedition) \b{Note:} This edition is for the development of \l{Qt Open Source Edition} {Free and Open Source} software only; see \l{Qt Commercial Editions}. \endif * / \endcode This QDoc comment will only be rendered if the \c opensourceedition preprocessor symbol is defined, and specified in the \l {defines-variable} {defines} variable in the configuration file to make QDoc process the code within #ifdef and #endif: \code defines = opensourceedition \endcode You can also define the preprocessor symbol manually on the command line. For more information see the documentation of the \l {defines-variable} {defines} variable. See also \l{endif-command} {\\endif}, \l{else-command} {\\else}, \l {defines-variable} {defines} and \l {falsehoods-variable} {falsehoods}. \target endif-command \section1 \\endif 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-command} {\\else}, \l {defines-variable} {defines} and \l {falsehoods-variable} {falsehoods}. \target else-command \section1 \\else 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 only two alternatives. \code / *! The Qt 3 support library is provided to keep old source code working. In addition to the \c Qt3Support classes, Qt 4 provides compatibility functions when it's possible for an old API to cohabit with the new one. \if !defined(QT3_SUPPORT) \if defined(QT3_SUPPORTWARNINGS) The compiler emits a warning when a compatibility function is called. (This works only with GCC 3.2+ and MSVC 7.) \else To use the Qt 3 support library, you need to have the line QT += qt3support in your .pro file (qmake automatically define the QT3_SUPPORT symbol, turning on compatibility function support). You can also define the symbol manually (for example, if you don't want to link against the \c Qt3Support library), or you can define \c QT3_SUPPORT_WARNINGS instead, telling the compiler to emit a warning when a compatibility function is called. (This works only with GCC 3.2+ and MSVC 7.) \endif \endif * / \endcode If the \c QT3_SUPPORT is defined, the comment will be rendered like this: \quotation The Qt 3 support library is provided to keep old source code working. In addition to the Qt3Support classes, Qt 4 provides compatibility functions when it's possible for an old API to cohabit with the new one. \endquotation If \c QT3_SUPPORT is not defined but \c QT3_SUPPORT_WARNINGS is defined, the comment will be rendered like this: \quotation The Qt 3 support library is provided to keep old source code working. In addition to the Qt3Support classes, Qt 4 provides compatibility functions when it's possible for an old API to cohabit with the new one. The compiler emits a warning when a compatibility function is called. (This works only with GCC 3.2+ and MSVC 7.) \endquotation If none of the symbols are defined, the comment will be rendered as \quotation The Qt 3 support library is provided to keep old source code working. In addition to the \c Qt3Support classes, Qt 4 provides compatibility functions when it's possible for an old API to cohabit with the new one. To use the Qt 3 support library, you need to have the line QT += qt3support in your .pro file (qmake automatically define the QT3_SUPPORT symbol, turning on compatibility function support). You can also define the symbol manually (e.g., if you don't want to link against the \c Qt3Support library), or you can define \c QT3_SUPPORT_WARNINGS instead, telling the compiler to emit a warning when a compatibility function is called. (This works only with GCC 3.2+ and MSVC 7.) \endquotation See also \l{if-command} {\\if}, \l{endif-command} {\\endif}, \l {defines-variable} {defines} and \l {falsehoods-variable} {falsehoods}. \target include-command \section1 \\include The \\include command sends all or part of the file specified by its first argument to the QDoc input stream to be processed as a QDoc comment snippet. This command is often assigned the alias, \e {input}, in the QDoc configuration file, for example \e {alias.include = input}. The command is useful when some snippet of commands and text is to be used in multiple places in the documentation. In that case, move the snippet into a separate file and use the \\include command wherever you want to insert the snippet into the documentation. To prevent QDoc from reading the file as a stand-alone page of documentation, we recommend that you use the \c .qdocinc extension for these \e {include} files. The command can have either one or two arguments. The first argument is always a file name. The contents of the file must be QDoc input, in other words, a sequence of QDoc commands and text, but without the enclosing QDoc comment \c{/}\c{*!} ... \c{*}\c{/} delimiters. If you want to include the entire named file, don't use the second argument. If you want to include only part of the file, see the \l{2-argument-form}{two argument form} below. Here is an example of the one argument form: \code / *! \page corefeatures.html \title Core Features \include examples/signalandslots.qdocinc \include examples/objectmodel.qdocinc \include examples/layoutmanagement.qdocinc * / \endcode QDoc renders this page \l{corefeatures.html} {as shown here}. \target 2-argument-form} \section2 \\include filename snippet-identifier It is a waste of time to make a separate \c .qdocinc file for every QDoc include snippet you want to use in multiple places in the documentation, especially given that you probably have to put the copyright/license notice in every one of these files. So if you have a large number of snippets to be included, you can put them all in a single file if you want, and surround each one with: \code //! [snippet-id1] QDoc commands and text... //! [snippet-id1] //! [snippet-id2] More QDoc commands and text... //! [snippet-id2] \endcode Then you can use the two-argument form of the command: \code \input examples/signalandslots.qdocinc snippet-id2 \input examples/objectmodel.qdocinc another-snippet-id \endcode It works as expected. The sequence of QDoc commands and text found between the two tags with the same name as the second argument is sent to the QDoc input stream. You can even nest these snippets, although it's not clear why you would want to do that. \target meta-command \section1 \\meta The \\meta command is mainly used for including metadata in DITA XML files. It is also used when generating HTML output for specifying the \e maintainer(s) of a C++ class. The command has two arguments: the first argument is the name of the metadata attribute, and the second argument is the value for the attribute. Each argument should be enclosed in curly brackets, as shown in this example: \code / *! \class QWidget \brief The QWidget class is the base class of all user interface objects. \ingroup basicwidgets \meta {technology} {User Interface} \meta {platform} {OS X 10.6} \meta {platform} {Symbian} \meta {platform} {MeeGo} \meta {audience} {user} \meta {audience} {programmer} \meta {audience} {designer} * / \endcode When running QDoc to generate HTML, the example above will have no effect on the generated output, but if you run QDoc to generate DITA XML, the example will generate the following: \code QWidget the QWidget class is the base class of all user interface objects. \endcode In the example output, several values have been set using default values obtained from the QDoc configuration file. See \l {Generating DITA XML Output} for details. \target omit-command \section1 \\omit The \\omit command and the corresponding \\endomit command delimit parts of the documentation that you want QDoc to skip. For example: \code / *! \table \row \li Basic Widgets \li Basic GUI widgets such as buttons, comboboxes and scrollbars. \omit \row \li Component Model \li Interfaces and helper classes for the Qt Component Model. \endomit \row \li Database Classes \li Database related classes, e.g. for SQL databases. \endtable * / \endcode QDoc renders this as: \raw HTML Qt Development Frameworks Qt Project Qt Project Class reference Qt Reference Documentation QtGui \endraw \target raw-command \section1 \\raw \span {class="newStuff"} {(avoid)} 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-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. The \\raw command is useful if you want some special HTML effects in your documentation. \code / *! Qt has some predefined QColor objects. \raw HTML
Basic Widgets Basic GUI widgets such as buttons, comboboxes and scrollbars. Database Classes Database related classes, e.g. for SQL databases. Blue(#0000ff), dark blue(#000080) and cyan(#00ffff).
\endraw * / \endcode QDoc renders this as: \quotation Qt has some predefined QColor objects. \raw HTMLBlue(#0000ff), dark blue(#000080) and cyan(#00ffff).
\endraw \endquotation \note But you can achieve the exact same thing using qdoc commands. In this case, all you have to do is include the color styles in your style.css file. Then you can write: \code \tt {\span {id="color-blue"} {Blue(#0000ff)}}, \tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and \tt {\span {id="color-cyan"} {cyan(#00ffff)}}. \endcode ...which is rendered as: \tt {\span {id="color-blue"} {Blue(#0000ff)}}, \tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and \tt {\span {id="color-cyan"} {cyan(#00ffff)}}. \target unicode-command \section1 \\unicode 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' or '0' prefix is specified (for base 16 and 8, respectively). For example: \code O G\unicode{0xEA}nio e as Rosas \unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour \unicode 0x3A3 \e{a}\sub{\e{i}} \endcode 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 \e{a}\sub{\e{i}} \endquotation */