diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-02-06 08:50:23 +0100 |
---|---|---|
committer | Oswald Buddenhagen <oswald.buddenhagen@digia.com> | 2013-02-06 09:44:18 +0100 |
commit | 419c6de73536a4a0bb59d679f8f557635c7cef53 (patch) | |
tree | faf61a3de1c19a763259fa748cf32e74652500f3 /src | |
parent | 276320caac4f0fd6399974a15a636a92ea6a7cfa (diff) | |
download | qt-creator-419c6de73536a4a0bb59d679f8f557635c7cef53.tar.gz |
Doc: replace deprecated QDoc commands
The \i and \o commands were replaced with \li and
\bold was replaced with \b in QDoc for Qt 5.
The \input command was replaced with \include in the docs.
Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Diffstat (limited to 'src')
35 files changed, 160 insertions, 160 deletions
diff --git a/src/libs/aggregation/aggregate.cpp b/src/libs/aggregation/aggregate.cpp index 37b8e8d748..e6979b0a13 100644 --- a/src/libs/aggregation/aggregate.cpp +++ b/src/libs/aggregation/aggregate.cpp @@ -55,8 +55,8 @@ other components in the Aggregate to the outside. Specifically that means: \list - \o They can be "cast" to each other (using query and query_all methods). - \o Their life cycle is coupled, i.e. whenever one is deleted all of them are. + \li They can be "cast" to each other (using query and query_all methods). + \li Their life cycle is coupled, i.e. whenever one is deleted all of them are. \endlist Components can be of any QObject derived type. diff --git a/src/libs/extensionsystem/iplugin.cpp b/src/libs/extensionsystem/iplugin.cpp index bb2964d390..062e9efdee 100644 --- a/src/libs/extensionsystem/iplugin.cpp +++ b/src/libs/extensionsystem/iplugin.cpp @@ -62,12 +62,12 @@ After the plugins' XML files have been read, and dependencies have been found, the plugin loading is done in three phases: \list 1 - \o All plugin libraries are loaded in \e{root-to-leaf} order of the + \li All plugin libraries are loaded in \e{root-to-leaf} order of the dependency tree. - \o All plugins' initialize methods are called in \e{root-to-leaf} order + \li All plugins' initialize methods are called in \e{root-to-leaf} order of the dependency tree. This is a good place to put objects in the plugin manager's object pool. - \o All plugins' extensionsInitialized methods are called in \e{leaf-to-root} + \li All plugins' extensionsInitialized methods are called in \e{leaf-to-root} order of the dependency tree. At this point, plugins can be sure that all plugins that depend on this plugin have been initialized completely (implying that they have put diff --git a/src/libs/extensionsystem/pluginmanager.cpp b/src/libs/extensionsystem/pluginmanager.cpp index caa9078e21..3657ff7d1b 100644 --- a/src/libs/extensionsystem/pluginmanager.cpp +++ b/src/libs/extensionsystem/pluginmanager.cpp @@ -80,8 +80,8 @@ enum { debugLeaks = 0 }; The plugin manager is used for the following tasks: \list - \o Manage plugins and their state - \o Manipulate a 'common object pool' + \li Manage plugins and their state + \li Manipulate a 'common object pool' \endlist \section1 Plugins @@ -186,13 +186,13 @@ enum { debugLeaks = 0 }; }; \endcode - \bold Note: The type of the parameters passed to the \c{invoke()} calls + \note The type of the parameters passed to the \c{invoke()} calls is deduced from the parameters themselves and must match the type of the arguments of the called functions \e{exactly}. No conversion or even integer promotions are applicable, so to invoke a function with a \c{long} parameter explicitly use \c{long(43)} or such. - \bold Note: The object pool manipulating functions are thread-safe. + \note The object pool manipulating functions are thread-safe. */ /*! diff --git a/src/libs/qmljs/qmljsevaluate.cpp b/src/libs/qmljs/qmljsevaluate.cpp index 79f6f35e28..78fc410fa2 100644 --- a/src/libs/qmljs/qmljsevaluate.cpp +++ b/src/libs/qmljs/qmljsevaluate.cpp @@ -56,8 +56,8 @@ using namespace QmlJS; Example: In a scope where "var a = 1" \list - \o value(Identifier-a) will return NumberValue - \o reference(Identifier-a) will return the ASTVariableReference for the declaration of "a" + \li value(Identifier-a) will return NumberValue + \li reference(Identifier-a) will return the ASTVariableReference for the declaration of "a" \endlist */ diff --git a/src/libs/qmljs/qmljsinterpreter.cpp b/src/libs/qmljs/qmljsinterpreter.cpp index ce4b8101dc..6627242ace 100644 --- a/src/libs/qmljs/qmljsinterpreter.cpp +++ b/src/libs/qmljs/qmljsinterpreter.cpp @@ -80,10 +80,10 @@ using namespace QmlJS::AST; Values are the result of many operations in the QmlJS code model: \list - \o \l{Evaluate} - \o Context::lookupType() and Context::lookupReference() - \o ScopeChain::lookup() - \o ObjectValue::lookupMember() + \li \l{Evaluate} + \li Context::lookupType() and Context::lookupReference() + \li ScopeChain::lookup() + \li ObjectValue::lookupMember() \endlist */ diff --git a/src/libs/qtcomponents/styleitem/qdeclarativefolderlistmodel.cpp b/src/libs/qtcomponents/styleitem/qdeclarativefolderlistmodel.cpp index a09f484b1f..e9c39e9d51 100644 --- a/src/libs/qtcomponents/styleitem/qdeclarativefolderlistmodel.cpp +++ b/src/libs/qtcomponents/styleitem/qdeclarativefolderlistmodel.cpp @@ -92,15 +92,15 @@ public: \e{Elements in the Qt.labs module are not guaranteed to remain compatible in future versions.} - \bold{import Qt.labs.folderlistmodel 1.0} + \b {import Qt.labs.folderlistmodel 1.0} The \l folder property specifies the folder to access. Information about the files and directories in the folder is supplied via the model's interface. Components access names and paths via the following roles: \list - \o fileName - \o filePath + \li fileName + \li filePath \endlist Additionally a file entry can be differentiated from a folder entry via the @@ -289,11 +289,11 @@ void QDeclarativeFolderListModel::componentComplete() The \a sortField property contains field to use for sorting. sortField may be one of: \list - \o Unsorted - no sorting is applied. The order is system default. - \o Name - sort by filename - \o Time - sort by time modified - \o Size - sort by file size - \o Type - sort by file type (extension) + \li Unsorted - no sorting is applied. The order is system default. + \li Name - sort by filename + \li Time - sort by time modified + \li Size - sort by file size + \li Type - sort by file type (extension) \endlist \sa sortReversed diff --git a/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp b/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp index ac6db960d1..5369fd2f95 100644 --- a/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp +++ b/src/libs/qtcreatorcdbext/qtcreatorcdbextension.cpp @@ -50,15 +50,15 @@ It provides \list - \o Notification about the state of the debugging session: + \li Notification about the state of the debugging session: \list - \o idle: (hooked with .idle_cmd) debuggee stopped - \o accessible: Debuggee stopped, cdb.exe accepts commands - \o inaccessible: Debuggee runs, no way to post commands - \o session active/inactive: Lost debuggee, terminating. + \li idle: (hooked with .idle_cmd) debuggee stopped + \li accessible: Debuggee stopped, cdb.exe accepts commands + \li inaccessible: Debuggee runs, no way to post commands + \li session active/inactive: Lost debuggee, terminating. \endlist - \o Hook up with output/event callbacks and produce formatted output - \o Provide some extension commands that produce output in a standardized (GDBMI) + \li Hook up with output/event callbacks and produce formatted output + \li Provide some extension commands that produce output in a standardized (GDBMI) format that ends up in handleExtensionMessage(). \endlist */ diff --git a/src/libs/qtcreatorcdbext/symbolgroupnode.cpp b/src/libs/qtcreatorcdbext/symbolgroupnode.cpp index f2c8ffbe86..009c46174b 100644 --- a/src/libs/qtcreatorcdbext/symbolgroupnode.cpp +++ b/src/libs/qtcreatorcdbext/symbolgroupnode.cpp @@ -582,12 +582,12 @@ void ErrorSymbolGroupNode::debug(std::ostream &os, const std::string &visitingFu Provides accessors for fixed-up symbol group value and a dumping facility consisting of: \list - \o 'Simple' dumping done when running the DumpVisitor. This produces one + \li 'Simple' dumping done when running the DumpVisitor. This produces one line of formatted output shown for the class. These values values are always displayed, while still allowing for expansion of the structure in the debugger. It also pre-determines some information for complex dumping (type, container). - \o 'Complex' dumping: Obscures the symbol group children by fake children, for + \li 'Complex' dumping: Obscures the symbol group children by fake children, for example container children, to be run when calling SymbolGroup::dump with an iname. The fake children are appended to the child list (other children are just marked as obscured for GDBMI dumping so that SymbolGroupValue expressions still work as before). diff --git a/src/libs/utils/fileinprojectfinder.cpp b/src/libs/utils/fileinprojectfinder.cpp index 0c70c4f1c9..d4fe24e6e8 100644 --- a/src/libs/utils/fileinprojectfinder.cpp +++ b/src/libs/utils/fileinprojectfinder.cpp @@ -48,8 +48,8 @@ namespace Utils { E.g. following file paths: \list - \i C:/app-build-desktop/qml/app/main.qml (shadow build directory) - \i /Users/x/app-build-desktop/App.app/Contents/Resources/qml/App/main.qml (folder on Mac OS X) + \li C:/app-build-desktop/qml/app/main.qml (shadow build directory) + \li /Users/x/app-build-desktop/App.app/Contents/Resources/qml/App/main.qml (folder on Mac OS X) \endlist should all be mapped to $PROJECTDIR/qml/app/main.qml diff --git a/src/libs/utils/parameteraction.cpp b/src/libs/utils/parameteraction.cpp index 340c5ee264..1d44a2fc39 100644 --- a/src/libs/utils/parameteraction.cpp +++ b/src/libs/utils/parameteraction.cpp @@ -37,8 +37,8 @@ The action has 2 states: \list - \o <no current parameter> displaying "Do XX" (empty text) - \o <parameter present> displaying "Do XX with %1". + \li <no current parameter> displaying "Do XX" (empty text) + \li <parameter present> displaying "Do XX with %1". \endlist Provides a slot to set the parameter, changing display diff --git a/src/libs/utils/persistentsettings.cpp b/src/libs/utils/persistentsettings.cpp index 29d1510e12..f6e57eef67 100644 --- a/src/libs/utils/persistentsettings.cpp +++ b/src/libs/utils/persistentsettings.cpp @@ -67,9 +67,9 @@ When parsing the structure, a parse stack of ParseValueStackEntry is used for each <data> element. ParseValueStackEntry is a variant/union of: \list - \o simple value - \o map - \o list + \li simple value + \li map + \li list \endlist When entering a value element ( \c <value> / \c <valuelist> , \c <valuemap> ), entry is pushed diff --git a/src/libs/utils/projectintropage.cpp b/src/libs/utils/projectintropage.cpp index 1f54f68e19..dc1ae6b806 100644 --- a/src/libs/utils/projectintropage.cpp +++ b/src/libs/utils/projectintropage.cpp @@ -45,8 +45,8 @@ Looks similar to FileWizardPage, but provides additional functionality: \list - \o Description label at the top for displaying introductory text - \o It does on the fly validation (connected to changed()) and displays + \li Description label at the top for displaying introductory text + \li It does on the fly validation (connected to changed()) and displays warnings/errors in a status label at the bottom (the page is complete when fully validated, validatePage() is thus not implemented). \endlist diff --git a/src/libs/utils/qtcprocess.cpp b/src/libs/utils/qtcprocess.cpp index 0d2c7e01a3..e2c9f5f824 100644 --- a/src/libs/utils/qtcprocess.cpp +++ b/src/libs/utils/qtcprocess.cpp @@ -203,11 +203,11 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) The behavior is based on the POSIX shell and bash: \list - \i Whitespace splits tokens - \i The backslash quotes the following character - \i A string enclosed in single quotes is not split. No shell meta + \li Whitespace splits tokens + \li The backslash quotes the following character + \li A string enclosed in single quotes is not split. No shell meta characters are interpreted. - \i A string enclosed in double quotes is not split. Within the string, + \li A string enclosed in double quotes is not split. Within the string, the backslash quotes shell meta characters - if it is followed by a "meaningless" character, the backslash is output verbatim. \endlist @@ -220,16 +220,16 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) The behavior is defined by the Microsoft C runtime: \list - \i Whitespace splits tokens - \i A string enclosed in double quotes is not split + \li Whitespace splits tokens + \li A string enclosed in double quotes is not split \list - \i 3N double quotes within a quoted string yield N literal quotes. + \li 3N double quotes within a quoted string yield N literal quotes. This is not documented on MSDN. \endlist - \i Backslashes have special semantics iff they are followed by a double quote: + \li Backslashes have special semantics iff they are followed by a double quote: \list - \i 2N backslashes + double quote => N backslashes and begin/end quoting - \i 2N+1 backslashes + double quote => N backslashes + literal quote + \li 2N backslashes + double quote => N backslashes and begin/end quoting + \li 2N+1 backslashes + double quote => N backslashes + literal quote \endlist \endlist Qt and many other implementations comply with this standard, but many do not. @@ -237,10 +237,10 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) If \a abortOnMeta is \c true, cmd shell semantics are applied before proceeding with word splitting: \list - \i Cmd ignores \e all special chars between double quotes. + \li Cmd ignores \e all special chars between double quotes. Note that the quotes are \e not removed at this stage - the tokenization rules described above still apply. - \i The \c circumflex is the escape char for everything including itself. + \li The \c circumflex is the escape char for everything including itself. \endlist As the quoting levels are independent from each other and have different semantics, you need a command line like \c{"foo "\^"" bar"} to get diff --git a/src/libs/utils/textfileformat.cpp b/src/libs/utils/textfileformat.cpp index 28a579f824..cbb58f9adc 100644 --- a/src/libs/utils/textfileformat.cpp +++ b/src/libs/utils/textfileformat.cpp @@ -65,9 +65,9 @@ QDebug operator<<(QDebug d, const TextFileFormat &format) The format comprises \list - \o Encoding represented by a pointer to a QTextCodec - \o Presence of an UTF8 Byte Order Marker (BOM) - \o Line feed storage convention + \li Encoding represented by a pointer to a QTextCodec + \li Presence of an UTF8 Byte Order Marker (BOM) + \li Line feed storage convention \endlist The class also provides convenience functions to read text files and return them diff --git a/src/plugins/coreplugin/actionmanager/actionmanager.cpp b/src/plugins/coreplugin/actionmanager/actionmanager.cpp index 574b97cf94..9fc242dd6d 100644 --- a/src/plugins/coreplugin/actionmanager/actionmanager.cpp +++ b/src/plugins/coreplugin/actionmanager/actionmanager.cpp @@ -127,14 +127,14 @@ using namespace Core::Internal; \section1 Important Guidelines: \list - \o Always register your actions and shortcuts! - \o Register your actions and shortcuts during your plugin's \l{ExtensionSystem::IPlugin::initialize()} + \li Always register your actions and shortcuts! + \li Register your actions and shortcuts during your plugin's \l{ExtensionSystem::IPlugin::initialize()} or \l{ExtensionSystem::IPlugin::extensionsInitialized()} methods, otherwise the shortcuts won't appear in the keyboard settings dialog from the beginning. - \o When registering an action with \c{cmd=registerAction(action, id, contexts)} be sure to connect + \li When registering an action with \c{cmd=registerAction(action, id, contexts)} be sure to connect your own action \c{connect(action, SIGNAL...)} but make \c{cmd->action()} visible to the user, i.e. \c{widget->addAction(cmd->action())}. - \o Use this class to add actions to the applications menus + \li Use this class to add actions to the applications menus \endlist \sa Core::ICore diff --git a/src/plugins/coreplugin/basefilewizard.cpp b/src/plugins/coreplugin/basefilewizard.cpp index bac79c0f78..cfb292e7f6 100644 --- a/src/plugins/coreplugin/basefilewizard.cpp +++ b/src/plugins/coreplugin/basefilewizard.cpp @@ -351,8 +351,8 @@ void WizardEventLoop::rejected() The abstract methods: \list - \o createWizardDialog(): Called to create the QWizard dialog to be shown - \o generateFiles(): Generate file content + \li createWizardDialog(): Called to create the QWizard dialog to be shown + \li generateFiles(): Generate file content \endlist must be implemented. diff --git a/src/plugins/coreplugin/dialogs/ioptionspage.cpp b/src/plugins/coreplugin/dialogs/ioptionspage.cpp index 11de40b3b7..db3b8006ca 100644 --- a/src/plugins/coreplugin/dialogs/ioptionspage.cpp +++ b/src/plugins/coreplugin/dialogs/ioptionspage.cpp @@ -38,15 +38,15 @@ into the plugin manager object pool (e.g. ExtensionSystem::PluginManager::addObject). Guidelines for implementing: \list - \o id() is a unique identifier for referencing this page - \o displayName() is the (translated) name for display - \o category() is the unique id for the category that the page should be displayed in - \o displayCategory() is the translated name of the category - \o createPage() is called to retrieve the widget to show in the preferences dialog + \li id() is a unique identifier for referencing this page + \li displayName() is the (translated) name for display + \li category() is the unique id for the category that the page should be displayed in + \li displayCategory() is the translated name of the category + \li createPage() is called to retrieve the widget to show in the preferences dialog The widget will be destroyed by the widget hierarchy when the dialog closes - \o apply() is called to store the settings. It should detect if any changes have been + \li apply() is called to store the settings. It should detect if any changes have been made and store those - \o finish() is called directly before the preferences dialog closes - \o matches() is used for the options dialog search filter + \li finish() is called directly before the preferences dialog closes + \li matches() is used for the options dialog search filter \endlist */ diff --git a/src/plugins/coreplugin/editormanager/ieditor.cpp b/src/plugins/coreplugin/editormanager/ieditor.cpp index af67b517a7..d9ad75fe8e 100644 --- a/src/plugins/coreplugin/editormanager/ieditor.cpp +++ b/src/plugins/coreplugin/editormanager/ieditor.cpp @@ -42,13 +42,13 @@ Guidelines for implementing: \list - \o displayName() is used as a user visible description of the document (usually filename w/o path). - \o kind() must be the same value as the kind() of the corresponding EditorFactory. - \o The changed() signal should be emitted when the modified state of the document changes + \li displayName() is used as a user visible description of the document (usually filename w/o path). + \li kind() must be the same value as the kind() of the corresponding EditorFactory. + \li The changed() signal should be emitted when the modified state of the document changes (so /bold{not} every time the document changes, but /bold{only once}). - \o If duplication is supported, you need to ensure that all duplicates + \li If duplication is supported, you need to ensure that all duplicates return the same file(). - \o QString preferredMode() const is the mode the editor manager should activate. + \li QString preferredMode() const is the mode the editor manager should activate. Some editors use a special mode (such as Design mode). \endlist diff --git a/src/plugins/coreplugin/icorelistener.h b/src/plugins/coreplugin/icorelistener.h index 9f83287456..fa918c7a2e 100644 --- a/src/plugins/coreplugin/icorelistener.h +++ b/src/plugins/coreplugin/icorelistener.h @@ -53,10 +53,10 @@ the core plugin. Guidelines for implementing: \list - \o Return false from the implemented method if you want to prevent the event. - \o You need to add your implementing object to the plugin managers objects: + \li Return false from the implemented method if you want to prevent the event. + \li You need to add your implementing object to the plugin managers objects: ExtensionSystem::PluginManager::instance()->addObject(yourImplementingObject); - \o Don't forget to remove the object again at deconstruction (e.g. in the destructor of + \li Don't forget to remove the object again at deconstruction (e.g. in the destructor of your plugin). */ class CORE_EXPORT ICoreListener : public QObject diff --git a/src/plugins/coreplugin/mimedatabase.cpp b/src/plugins/coreplugin/mimedatabase.cpp index 3066cb2e03..ccbe55a95d 100644 --- a/src/plugins/coreplugin/mimedatabase.cpp +++ b/src/plugins/coreplugin/mimedatabase.cpp @@ -1191,21 +1191,21 @@ MimeMapEntry::MimeMapEntry(const MimeType &t, int aLevel) : Storage requirements: \list - \o Must be robust in case of incomplete hierarchies, dangling entries - \o Plugins will not load and register their mime types in order of inheritance. - \o Multiple inheritance (several subClassesOf) can occur - \o Provide quick lookup by name - \o Provide quick lookup by file type. + \li Must be robust in case of incomplete hierarchies, dangling entries + \li Plugins will not load and register their mime types in order of inheritance. + \li Multiple inheritance (several subClassesOf) can occur + \li Provide quick lookup by name + \li Provide quick lookup by file type. \endlist This basically rules out some pointer-based tree, so the structure chosen is: \list - \o An alias map QString->QString for mapping aliases to types - \o A Map QString->MimeMapEntry for the types (MimeMapEntry being a pair of + \li An alias map QString->QString for mapping aliases to types + \li A Map QString->MimeMapEntry for the types (MimeMapEntry being a pair of MimeType and (hierarchy) level. - \o A map QString->QString representing parent->child relations (enabling + \li A map QString->QString representing parent->child relations (enabling recursing over children) - \o Using strings avoids dangling pointers. + \li Using strings avoids dangling pointers. \endlist The hierarchy level is used for mapping by file types. When findByFile() diff --git a/src/plugins/coreplugin/progressmanager/progressmanager.cpp b/src/plugins/coreplugin/progressmanager/progressmanager.cpp index 5afa119c82..4f170f41e1 100644 --- a/src/plugins/coreplugin/progressmanager/progressmanager.cpp +++ b/src/plugins/coreplugin/progressmanager/progressmanager.cpp @@ -57,32 +57,32 @@ using namespace Core::Internal; \table \header - \o Property - \o Type - \o Description + \li Property + \li Type + \li Description \row - \o Task abstraction - \o \c QFuture<void> - \o A \c QFuture object that represents the task which is + \li Task abstraction + \li \c QFuture<void> + \li A \c QFuture object that represents the task which is responsible for reporting the state of the task. See below for coding patterns how to create this object for your specific task. \row - \o Title - \o \c QString - \o A very short title describing your task. This is shown + \li Title + \li \c QString + \li A very short title describing your task. This is shown as a title over the progress bar. \row - \o Type - \o \c QString - \o A string identifier that is used to group different tasks that + \li Type + \li \c QString + \li A string identifier that is used to group different tasks that belong together. For example, all the search operations use the same type identifier. \row - \o Flags - \o \l ProgressManager::ProgressFlags - \o Additional flags that specify how the progress bar should + \li Flags + \li \l ProgressManager::ProgressFlags + \li Additional flags that specify how the progress bar should be presented to the user. \endtable diff --git a/src/plugins/cpptools/cpppointerdeclarationformatter.h b/src/plugins/cpptools/cpppointerdeclarationformatter.h index 214e72396c..e43a58bc49 100644 --- a/src/plugins/cpptools/cpppointerdeclarationformatter.h +++ b/src/plugins/cpptools/cpppointerdeclarationformatter.h @@ -55,9 +55,9 @@ typedef Utils::ChangeSet::Range Range; The following constructs are supported: \list - \o Simple declarations - \o Parameters and return types of function declarations and definitions - \o Control flow statements like if, while, for, foreach + \li Simple declarations + \li Parameters and return types of function declarations and definitions + \li Control flow statements like if, while, for, foreach \endlist */ diff --git a/src/plugins/debugger/cdb/cdbengine.cpp b/src/plugins/debugger/cdb/cdbengine.cpp index 1fa38bdda1..9461b63051 100644 --- a/src/plugins/debugger/cdb/cdbengine.cpp +++ b/src/plugins/debugger/cdb/cdbengine.cpp @@ -119,22 +119,22 @@ enum HandleLocalsFlags library (32/64bit), which is loaded into cdb.exe. It serves to: \list - \o Notify the engine about the state of the debugging session: + \li Notify the engine about the state of the debugging session: \list - \o idle: (hooked up with .idle_cmd) debuggee stopped - \o accessible: Debuggee stopped, cdb.exe accepts commands - \o inaccessible: Debuggee runs, no way to post commands - \o session active/inactive: Lost debuggee, terminating. + \li idle: (hooked up with .idle_cmd) debuggee stopped + \li accessible: Debuggee stopped, cdb.exe accepts commands + \li inaccessible: Debuggee runs, no way to post commands + \li session active/inactive: Lost debuggee, terminating. \endlist - \o Hook up with output/event callbacks and produce formatted output to be able + \li Hook up with output/event callbacks and produce formatted output to be able to catch application output and exceptions. - \o Provide some extension commands that produce output in a standardized (GDBMI) + \li Provide some extension commands that produce output in a standardized (GDBMI) format that ends up in handleExtensionMessage(), for example: \list - \o pid Return debuggee pid for interrupting. - \o locals Print locals from SymbolGroup - \o expandLocals Expand locals in symbol group - \o registers, modules, threads + \li pid Return debuggee pid for interrupting. + \li locals Print locals from SymbolGroup + \li expandLocals Expand locals in symbol group + \li registers, modules, threads \endlist \endlist @@ -142,11 +142,11 @@ enum HandleLocalsFlags \list - \o postCommand(): Does not expect a reply - \o postBuiltinCommand(): Run a builtin-command producing free-format, multiline output + \li postCommand(): Does not expect a reply + \li postBuiltinCommand(): Run a builtin-command producing free-format, multiline output that is captured by enclosing it in special tokens using the 'echo' command and then invokes a callback with a CdbBuiltinCommand structure. - \o postExtensionCommand(): Run a command provided by the extension producing + \li postExtensionCommand(): Run a command provided by the extension producing one-line output and invoke a callback with a CdbExtensionCommand structure (output is potentially split up in chunks). \endlist diff --git a/src/plugins/debugger/memoryagent.cpp b/src/plugins/debugger/memoryagent.cpp index 43da6fdaf9..c6e635f988 100644 --- a/src/plugins/debugger/memoryagent.cpp +++ b/src/plugins/debugger/memoryagent.cpp @@ -70,9 +70,9 @@ namespace Internal { Memory can be shown as \list - \o Editor: Create an IEditor using the normal editor factory + \li Editor: Create an IEditor using the normal editor factory interface (m_editors) - \o View: Separate top-level view consisting of a Bin Editor widget + \li View: Separate top-level view consisting of a Bin Editor widget (m_view). \endlist diff --git a/src/plugins/find/ifindfilter.cpp b/src/plugins/find/ifindfilter.cpp index 4fd3e2e62a..f126b12afc 100644 --- a/src/plugins/find/ifindfilter.cpp +++ b/src/plugins/find/ifindfilter.cpp @@ -59,10 +59,10 @@ If you want to implement a more specialized find filter, you'll need to \list - \o Start your search in a separate thread - \o Make this known to the Core::ProgressManager, for a progress bar + \li Start your search in a separate thread + \li Make this known to the Core::ProgressManager, for a progress bar and the ability to cancel the search - \o Interface with the shared \gui{Search Results} panel, to show + \li Interface with the shared \gui{Search Results} panel, to show the search results, handle the event that the user click on one of the search result items, and possible handle a global replace of all or some of the search result items. diff --git a/src/plugins/macros/macroevent.cpp b/src/plugins/macros/macroevent.cpp index 59f9a7ac53..fc88ee409c 100644 --- a/src/plugins/macros/macroevent.cpp +++ b/src/plugins/macros/macroevent.cpp @@ -41,10 +41,10 @@ using namespace Macros; An event stores information so it can be replayed. An event can be: \list - \o menu action - \o key event on an editor - \o find/replace usage - \o ... + \li menu action + \li key event on an editor + \li find/replace usage + \li ... \endlist The information are stored in a map of QVariants (using quint8 for keys). diff --git a/src/plugins/macros/macromanager.cpp b/src/plugins/macros/macromanager.cpp index 63a623038b..12372f855e 100644 --- a/src/plugins/macros/macromanager.cpp +++ b/src/plugins/macros/macromanager.cpp @@ -80,8 +80,8 @@ using namespace Macros::Internal; There are two important methods in this class that can be used outside the Macros plugin: \list - \o registerEventHandler: add a new event handler - \o registerAction: add a macro event when this action is triggered + \li registerEventHandler: add a new event handler + \li registerAction: add a macro event when this action is triggered \endlist This class is a singleton and can be accessed using the instance method. diff --git a/src/plugins/projectexplorer/abstractprocessstep.cpp b/src/plugins/projectexplorer/abstractprocessstep.cpp index ad6ee8c24c..a5b6428964 100644 --- a/src/plugins/projectexplorer/abstractprocessstep.cpp +++ b/src/plugins/projectexplorer/abstractprocessstep.cpp @@ -53,12 +53,12 @@ using namespace ProjectExplorer; Usage: \list - \o Use processParameters() to configure the process you want to run + \li Use processParameters() to configure the process you want to run (you need to do that before calling AbstractProcessStep::init()). - \o Inside YourBuildStep::init() call AbstractProcessStep::init(). - \o Inside YourBuildStep::run() call AbstractProcessStep::run(), which automatically starts the proces + \li Inside YourBuildStep::init() call AbstractProcessStep::init(). + \li Inside YourBuildStep::run() call AbstractProcessStep::run(), which automatically starts the process and by default adds the output on stdOut and stdErr to the OutputWindow. - \o If you need to process the process output override stdOut() and/or stdErr. + \li If you need to process the process output override stdOut() and/or stdErr. \endlist The two functions processStarted() and processFinished() are called after starting/finishing the process. diff --git a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp index 37e8a25c07..87d84c721f 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp @@ -908,12 +908,12 @@ bool replaceFieldHelper(ValueStringTransformation transform, Replace field values delimited by '%' with special modifiers: \list - \o %Field% -> simple replacement - \o %Field:l% -> replace with everything changed to lower case - \o %Field:u% -> replace with everything changed to upper case - \o %Field:c% -> replace with first character capitalized - \o %Field:h% -> replace with something usable as header guard - \o %Field:s% -> replace with something usable as structure or class name + \li %Field% -> simple replacement + \li %Field:l% -> replace with everything changed to lower case + \li %Field:u% -> replace with everything changed to upper case + \li %Field:c% -> replace with first character capitalized + \li %Field:h% -> replace with something usable as header guard + \li %Field:s% -> replace with something usable as structure or class name \endlist The return value indicates whether non-empty replacements were encountered. diff --git a/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp b/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp index db638aecaa..438a20d204 100644 --- a/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp +++ b/src/plugins/projectexplorer/customwizard/customwizardscriptgenerator.cpp @@ -226,12 +226,12 @@ Core::GeneratedFiles As Qt Creator needs to know the file names before actually creates them to do overwrite checking etc., this is 2-step process: \list - \o Determine file names and attributes: The script is called with the + \li Determine file names and attributes: The script is called with the \c --dry-run option and the field values. It then prints the relative path names it intends to create followed by comma-separated attributes matching those of the \c <file> element, for example: \c myclass.cpp,openeditor - \o The script is called with the parameters only in the working directory + \li The script is called with the parameters only in the working directory and then actually creates the files. If that involves directories, the script should create those, too. \endlist diff --git a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp index ae3e896658..6025395d08 100644 --- a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp +++ b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp @@ -299,9 +299,9 @@ DeviceProcess DeviceProcessesDialogPrivate::selectedProcess() const The dialog can be used as a \list - \o Non-modal dialog showing a list of processes: Call addCloseButton() + \li Non-modal dialog showing a list of processes: Call addCloseButton() to add a 'Close' button. - \o Modal dialog with an 'Accept' button to select a process: Call + \li Modal dialog with an 'Accept' button to select a process: Call addAcceptButton() passing the label text. This will create a 'Cancel' button as well. \endlist diff --git a/src/plugins/projectexplorer/projectfilewizardextension.cpp b/src/plugins/projectexplorer/projectfilewizardextension.cpp index 28b9de349a..c4fca9ea4e 100644 --- a/src/plugins/projectexplorer/projectfilewizardextension.cpp +++ b/src/plugins/projectexplorer/projectfilewizardextension.cpp @@ -69,8 +69,8 @@ Offers: \list - \o Add to a project file (*.pri/ *.pro) - \o Initialize a version control repository (unless the path is already + \li Add to a project file (*.pri/ *.pro) + \li Initialize a version control repository (unless the path is already managed) and do 'add' if the VCS supports it. \endlist diff --git a/src/plugins/qmljstools/qmljsplugindumper.cpp b/src/plugins/qmljstools/qmljsplugindumper.cpp index 24bcc8fc3f..41e29f19fd 100644 --- a/src/plugins/qmljstools/qmljsplugindumper.cpp +++ b/src/plugins/qmljstools/qmljsplugindumper.cpp @@ -489,12 +489,12 @@ QString PluginDumper::resolvePlugin(const QDir &qmldirPath, const QString &qmldi Adapted from QDeclarativeImportDatabase::resolvePlugin. \table - \header \i Platform \i Valid suffixes - \row \i Windows \i \c .dll - \row \i Unix/Linux \i \c .so - \row \i AIX \i \c .a - \row \i HP-UX \i \c .sl, \c .so (HP-UXi) - \row \i Mac OS X \i \c .dylib, \c .bundle, \c .so + \header \li Platform \li Valid suffixes + \row \li Windows \li \c .dll + \row \li Unix/Linux \li \c .so + \row \li AIX \li \c .a + \row \li HP-UX \li \c .sl, \c .so (HP-UXi) + \row \li Mac OS X \li \c .dylib, \c .bundle, \c .so \endtable Version number on unix are ignored. diff --git a/src/plugins/texteditor/snippets/isnippetprovider.cpp b/src/plugins/texteditor/snippets/isnippetprovider.cpp index 29722fd84f..6f398cd43c 100644 --- a/src/plugins/texteditor/snippets/isnippetprovider.cpp +++ b/src/plugins/texteditor/snippets/isnippetprovider.cpp @@ -42,21 +42,21 @@ using namespace TextEditor; In order to create a new group of snippets two steps are necessary: \list - \o Implement the TextEditor::ISnippetProvider interface and register it in + \li Implement the TextEditor::ISnippetProvider interface and register it in the extension system. - \o Create an XML configuration file and place it in the + \li Create an XML configuration file and place it in the /share/qtcreator/snippets directory. As an example of the file format please take a look at the already available ones. The meaning and consistency rules of the fields are described below: \list - \o group - This is the group in which the snippet belongs in the user interface. + \li group - This is the group in which the snippet belongs in the user interface. It must match TextEditor::ISnippetProvider::groupId(). - \o id - A unique string that identifies this snippet among all others available. + \li id - A unique string that identifies this snippet among all others available. The recommended practice is to prefix it with the group so it is easier to have such control on a file level. - \o trigger - The sequence of characters to be compared by the completion engine + \li trigger - The sequence of characters to be compared by the completion engine in order to display this snippet as a code assist proposal. - \o complement - Additional information that is displayed in the code assist + \li complement - Additional information that is displayed in the code assist proposal so it is possible to disambiguate similar snippets that have the same trigger. \endlist diff --git a/src/plugins/vcsbase/vcsbaseplugin.cpp b/src/plugins/vcsbase/vcsbaseplugin.cpp index ac4846548c..66789ea3c8 100644 --- a/src/plugins/vcsbase/vcsbaseplugin.cpp +++ b/src/plugins/vcsbase/vcsbaseplugin.cpp @@ -313,8 +313,8 @@ public: Qt Creator's state relevant to VCS plugins is a tuple of \list - \o Current file and it's version system control/top level - \o Current project and it's version system control/top level + \li Current file and it's version system control/top level + \li Current project and it's version system control/top level \endlist \sa VcsBase::VcsBasePlugin |