diff options
author | Tobias Hunger <tobias.hunger@digia.com> | 2013-09-25 18:19:45 +0200 |
---|---|---|
committer | Tobias Hunger <tobias.hunger@digia.com> | 2013-09-26 09:56:22 +0200 |
commit | 0479abdcd78917c52ae0d77a4e4b8994cf704336 (patch) | |
tree | 76f779b1e0c3e020f5fc48cdff62b2ba2fe152a3 /doc/api/first-plugin.qdoc | |
parent | 529cc963b54b2d5d8ec08241c437a8a76318060b (diff) |
QDoc: Fix QDoc warnings
This patch fixes ~1100 warnings from qdoc
Change-Id: Ia9555db675acbf8083b2f87d9855a62a3a34ccb9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'doc/api/first-plugin.qdoc')
-rw-r--r-- | doc/api/first-plugin.qdoc | 152 |
1 files changed, 76 insertions, 76 deletions
diff --git a/doc/api/first-plugin.qdoc b/doc/api/first-plugin.qdoc index 1ee6868508b..0f14611e583 100644 --- a/doc/api/first-plugin.qdoc +++ b/doc/api/first-plugin.qdoc @@ -36,81 +36,81 @@ your plugin with. \list 1 - \o Select \gui{File > New File or Project > Libraries > Qt Creator Plugin > Choose}. + \li Select \gui{File > New File or Project > Libraries > Qt Creator Plugin > Choose}. - \image firstplugin-wizard.png "Choose the \QC Plugin Wizard" + \image firstplugin-wizard.png "Choose the \QC Plugin Wizard" - The \gui{Introduction and Project Location} dialog opens. + The \gui{Introduction and Project Location} dialog opens. - \image firstplugin-nameandpath.png "Choose Name and Place of the Project" + \image firstplugin-nameandpath.png "Choose Name and Place of the Project" - \o Give your project a name and specify in which path - this project will be created. The actual plugin's name can be different - from the project name. You will choose that name later in the wizard. - Continue to the next page. + \li Give your project a name and specify in which path + this project will be created. The actual plugin's name can be different + from the project name. You will choose that name later in the wizard. + Continue to the next page. - The \gui{Kit Selection} dialog opens. + The \gui{Kit Selection} dialog opens. - \image firstplugin-kitselection.png "Choose the kit to build and run your project with" + \image firstplugin-kitselection.png "Choose the kit to build and run your project with" - \o Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with. - For a \QC plugin this needs to be a kit with \gui{Desktop} device type, - and a Qt version that is compatible with the Qt version that your - \QC was built with (in the best case the exact same build). - If you use an incompatible Qt version to build your plugin, you - will get errors while \QC tries to load your plugin. - Continue to the next page. + \li Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with. + For a \QC plugin this needs to be a kit with \gui{Desktop} device type, + and a Qt version that is compatible with the Qt version that your + \QC was built with (in the best case the exact same build). + If you use an incompatible Qt version to build your plugin, you + will get errors while \QC tries to load your plugin. + Continue to the next page. - The \gui{Plugin Information} dialog opens. + The \gui{Plugin Information} dialog opens. - \image firstplugin-pluginsetup.png "Specify Your Plugin Details" + \image firstplugin-pluginsetup.png "Specify Your Plugin Details" - \o In the \gui{Plugin name} field, type \gui{Example}. The name of the plugin - is used as its identifier, and also is the base for the file names and - classes in the code. + \li In the \gui{Plugin name} field, type \gui{Example}. The name of the plugin + is used as its identifier, and also is the base for the file names and + classes in the code. - \o The values of the following fields are mainly informational, and - are shown in the detailed view in \QC's plugin overview - (\gui{Help > About Plugins}, or \gui{Qt Creator > About Plugins} - on Mac). + \li The values of the following fields are mainly informational, and + are shown in the detailed view in \QC's plugin overview + (\gui{Help > About Plugins}, or \gui{Qt Creator > About Plugins} + on Mac). - \list - \o \gui{Vendor name} is a short one-word name of the company - or organization that created the plugin. This is also used for - the path name where the plugin will be deployed to. - \o \gui{Copyright} is a one-line, short copyright string. - \o \gui{License} is a multi-line license text (but shouldn't be pages over pages long, - since the interface doesn't allow nice reading of long texts). - \o \gui{Description} is a relatively short, but - possibly multi-line description of what the plugin does. - \o \gui{URL} is a website where the user can find more - information about the plugin and/or organization providing it. + \list + \li \gui{Vendor name} is a short one-word name of the company + or organization that created the plugin. This is also used for + the path name where the plugin will be deployed to. + \li \gui{Copyright} is a one-line, short copyright string. + \li \gui{License} is a multi-line license text (but shouldn't be pages over pages long, + since the interface doesn't allow nice reading of long texts). + \li \gui{Description} is a relatively short, but + possibly multi-line description of what the plugin does. + \li \gui{URL} is a website where the user can find more + information about the plugin and/or organization providing it. \endlist - \o Set the \gui{Qt Creator sources} and \gui{Qt Creator build} fields to - the source and build directory of the \QC - instance you want to use to test your plugin with, respectively. - If you don't do that correctly you will get compile errors for your - plugin, and your plugin might not show up in \QC at all. - - \o In the \gui{Deploy into} list, select \gui{Qt Creator build}. This sets - your .pro file up to deploy your plugin directly into your \QC build's - plugin directory (requires you to have write permissions there). - The other option, \gui{Local user settings}, sets your .pro file up to - deploy your plugin into \QC's user plugin path - (for example \c{~/.config/QtProject/qtcreator/plugins} on Unix systems). - We choose \gui{Qt Creator build} because we use a self-compiled - \QC, and want the plugin to be only loaded by that \QC - instance. - Continue to the next page. - - The \gui{Project Management} dialog opens. - - \image firstplugin-summary.png "Summary of Created Files" - - \o Review the files that will be created, choose a version control - system that \QC should use for your project (always a good idea!), - and finish the wizard. + \li Set the \gui{Qt Creator sources} and \gui{Qt Creator build} fields to + the source and build directory of the \QC + instance you want to use to test your plugin with, respectively. + If you don't do that correctly you will get compile errors for your + plugin, and your plugin might not show up in \QC at all. + + \li In the \gui{Deploy into} list, select \gui{Qt Creator build}. This sets + your .pro file up to deploy your plugin directly into your \QC build's + plugin directory (requires you to have write permissions there). + The other option, \gui{Local user settings}, sets your .pro file up to + deploy your plugin into \QC's user plugin path + (for example \c{~/.config/QtProject/qtcreator/plugins} on Unix systems). + We choose \gui{Qt Creator build} because we use a self-compiled + \QC, and want the plugin to be only loaded by that \QC + instance. + Continue to the next page. + + The \gui{Project Management} dialog opens. + + \image firstplugin-summary.png "Summary of Created Files" + + \li Review the files that will be created, choose a version control + system that \QC should use for your project (always a good idea!), + and finish the wizard. \endlist \section1 Building and Running the Plugin @@ -138,26 +138,26 @@ \table \header - \o File - \o Role + \li File + \li Role \row - \o \c{Example.pluginspec.in} - \o Template plugin specification. QMake creates a \c{Example.pluginspec} - from this file, which is read by \QC to find out about the plugin. + \li \c{Example.pluginspec.in} + \li Template plugin specification. QMake creates a \c{Example.pluginspec} + from this file, which is read by \QC to find out about the plugin. \row - \o \c{example.pro} - \o Project file, used by QMake to generate a Makefile that then is used to - build the plugin. + \li \c{example.pro} + \li Project file, used by QMake to generate a Makefile that then is used to + build the plugin. \row - \o \c{example_global.h} - \o Contains macro definitions that are useful when this plugin should export - symbols to other plugins. + \li \c{example_global.h} + \li Contains macro definitions that are useful when this plugin should export + symbols to other plugins. \row - \o \c{exampleconstants.h} - \o Header defining constants used by the plugin code. + \li \c{exampleconstants.h} + \li Header defining constants used by the plugin code. \row - \o \c{exampleplugin.h/.cpp} - \o C++ header and source files that define the plugin class that will be + \li \c{exampleplugin.h/.cpp} + \li C++ header and source files that define the plugin class that will be instanciated and run by \QC's plugin manager. \endtable |