forked from qt-creator/qt-creator
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>
This commit is contained in:
committed by
Oswald Buddenhagen
parent
276320caac
commit
419c6de735
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
*/
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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()
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user