Including Code Inline

\code

The \code and \endcode commands enclose a snippet of source code.

Note: The \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, \badcode, \newcode or \oldcode commands, QDoc removes all indentation that is common for the verbatim code blocks within a /*! ... */ 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 \quotefromfile or \quotefile command.

 / *!
     \code
         #include <QApplication>
         #include <QPushButton>

         int main(int argc, char *argv[])
         {
             ...
         }
     \ endcode
 * /

QDoc renders this as:

     #include <QApplication>
     #include <QPushButton>

     int main(int argc, char *argv[])
     {
         ...
     }

Other QDoc commands are disabled within \code... \endcode, and the special character '\' is accepted and rendered like the rest of the code.

To include code snippets from an external file, use the \snippet and \codeline commands.

See also \c, \quotefromfile, \badcode, \newcode and \oldcode.

 / *!
     The statement below is rendered using the
     regular \\code command:

     \code
         statusbar()->message(tr("Host %1 found").arg(hostName));
     \ endcode

     While the following  statement is rendered using
     the \\badcode command:

     \badcode
         statusbar()->message(tr("Host" + hostName + " found"));
     \ endcode
 * /

 / *!
     \oldcode
         if (printer->setup(parent))
             ...
     \newcode
         QPrintDialog dialog(printer, parent);
             if (dialog.exec())
                 ...
     \ endcode
 * /

 / *!
     \qml
         import QtQuick 1.0

         Row {
             Rectangle {
                 width: 100; height: 100
                 color: "blue"
                 transform: Translate { y: 20 }
             }
             Rectangle {
                 width: 100; height: 100
                 color: "red"
                 transform: Translate { y: -20 }
             }
         }
     \endqml
 * /

     import QtQuick 1.0

     Row {
         Rectangle {
             width: 100; height: 100
             color: "blue"
             transform: Translate { y: 20 }
         }
         Rectangle {
             width: 100; height: 100
             color: "red"
             transform: Translate { y: -20 }
         }
     }