diff options
author | Nikolai Kosjar <nikolai.kosjar@digia.com> | 2013-10-07 13:34:40 +0200 |
---|---|---|
committer | Nikolai Kosjar <nikolai.kosjar@digia.com> | 2013-10-10 15:56:12 +0200 |
commit | b8dbac0b9c4c45ee0d17d16eeae9086a14e9656a (patch) | |
tree | 784eb7872148f25bbe34a650b7c152e990ede927 /doc | |
parent | a48315ee1f5372cacc749a2cf985f55d1e312dbd (diff) | |
download | qt-creator-b8dbac0b9c4c45ee0d17d16eeae9086a14e9656a.tar.gz |
Rename "[Mm]ethod(s)" to "[Ff]unction(s)"
Only methods as programming functions are affected. Besides renaming
some actions like "Switch Between Function Declaration/Definition" this
mostly touches (api) code comments.
This is a follow-up patch to commit 872bfb7.
Change-Id: Icb65e8d73b59a022f8885b14df497169543a3b92
Reviewed-by: hjk <hjk121@nokiamail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/addressbook-sdk.qdoc | 4 | ||||
-rw-r--r-- | doc/api/coding-style.qdoc | 12 | ||||
-rw-r--r-- | doc/api/examples/exampleplugin/exampleplugin.cpp | 4 | ||||
-rw-r--r-- | doc/api/examples/exampleplugin/exampleplugin.h | 4 | ||||
-rw-r--r-- | doc/api/first-plugin.qdoc | 10 | ||||
-rw-r--r-- | doc/api/plugin-lifecycle.qdoc | 22 | ||||
-rw-r--r-- | doc/api/plugin-specifications.qdoc | 4 | ||||
-rw-r--r-- | doc/api/pluginmanager.qdoc | 10 | ||||
-rw-r--r-- | doc/api/qtcreator-dev-wizards.qdoc | 2 | ||||
-rw-r--r-- | doc/src/debugger/creator-debugger.qdoc | 4 | ||||
-rw-r--r-- | doc/src/editors/creator-coding-edit-mode.qdoc | 8 | ||||
-rw-r--r-- | doc/src/editors/creator-coding.qdoc | 2 | ||||
-rw-r--r-- | doc/src/editors/creator-editors.qdoc | 32 | ||||
-rw-r--r-- | doc/src/editors/creator-finding.qdoc | 2 | ||||
-rw-r--r-- | doc/src/howto/creator-keyboard-shortcuts.qdoc | 4 | ||||
-rw-r--r-- | doc/src/howto/creator-tips.qdoc | 2 | ||||
-rw-r--r-- | doc/src/howto/creator-ui.qdoc | 2 | ||||
-rw-r--r-- | doc/src/howto/qtcreator-faq.qdoc | 10 |
18 files changed, 69 insertions, 69 deletions
diff --git a/doc/addressbook-sdk.qdoc b/doc/addressbook-sdk.qdoc index e5e9ac6072..1f6ac54dc5 100644 --- a/doc/addressbook-sdk.qdoc +++ b/doc/addressbook-sdk.qdoc @@ -357,7 +357,7 @@ \image addressbook-tutorial-part2-signals-and-slots.png Finally, set the window title to "Simple Address Book" using the - \l{QWidget::}{setWindowTitle()} function. The tr() method allows us + \l{QWidget::}{setWindowTitle()} function. The tr() function allows us to translate user interface strings. \snippet examples/addressbook-sdk/part2/addressbook.cpp window title @@ -827,7 +827,7 @@ when you enter a contact name to look up. Once you click the dialog's \c findButton, the dialog is hidden and the result code is set to either QDialog::Accepted or QDialog::Rejected by the FindDialog's - \c findClicked() method. This ensures that you only search for a contact + \c findClicked() function. This ensures that you only search for a contact if you have typed something in the FindDialog's line edit. Then proceed to extract the search string, which in this case is diff --git a/doc/api/coding-style.qdoc b/doc/api/coding-style.qdoc index 6ed309f0a6..c01b131919 100644 --- a/doc/api/coding-style.qdoc +++ b/doc/api/coding-style.qdoc @@ -86,10 +86,10 @@ backward source code compatibility in patch releases, so: \list - \li Do not add or remove any public API (e.g. global functions,x - public/protected/private methods). - \li Do not reimplement methods (not even inlines, - nor protected or private methods). + \li Do not add or remove any public API (e.g. global functions, + public/protected/private member functions). + \li Do not reimplement functions (not even inlines, + nor protected or private functions). \li Check \l {http://wiki.qt-project.org/index.php/Binary_Compatibility_Workarounds}{Binary Compatibility Workarounds} for ways to preserve binary compatibility. @@ -687,7 +687,7 @@ will not remove the const modifier. \li Do not use \c dynamic_cast, use \c {qobject_cast} for QObjects, or refactor your design, for example by introducing a \c {type()} - method (see QListWidgetItem), unless you know what you do. + function (see QListWidgetItem), unless you know what you do. \endlist \section2 Compiler and Platform-specific Issues @@ -854,7 +854,7 @@ binary 0, instead of comparing it to 0.0, or, preferred, move such code into an implementation file. - \li Do not hide virtual methods in subclasses (\{-Woverloaded-virtual}). + \li Do not hide virtual functions in subclasses (\{-Woverloaded-virtual}). If the baseclass A has a virtual \c {int val()} and subclass B an overload with the same name, \c {int val(int x)}, the A \c val function is hidden. Use the \c using keyword to make it visible again, and diff --git a/doc/api/examples/exampleplugin/exampleplugin.cpp b/doc/api/examples/exampleplugin/exampleplugin.cpp index 67da9bda17..147a4274b9 100644 --- a/doc/api/examples/exampleplugin/exampleplugin.cpp +++ b/doc/api/examples/exampleplugin/exampleplugin.cpp @@ -34,7 +34,7 @@ bool ExamplePlugin::initialize(const QStringList &arguments, QString *errorStrin // Load settings // Add actions to menus // Connect to other plugins' signals - // In the initialize method, a plugin can be sure that the plugins it + // In the initialize function, a plugin can be sure that the plugins it // depends on have initialized their members. Q_UNUSED(arguments) @@ -62,7 +62,7 @@ bool ExamplePlugin::initialize(const QStringList &arguments, QString *errorStrin void ExamplePlugin::extensionsInitialized() { // Retrieve objects from the plugin manager's object pool - // In the extensionsInitialized method, a plugin can be sure that all + // In the extensionsInitialized function, a plugin can be sure that all // plugins that depend on it are completely initialized. } diff --git a/doc/api/examples/exampleplugin/exampleplugin.h b/doc/api/examples/exampleplugin/exampleplugin.h index c288abf085..4b7b4e893e 100644 --- a/doc/api/examples/exampleplugin/exampleplugin.h +++ b/doc/api/examples/exampleplugin/exampleplugin.h @@ -20,11 +20,11 @@ public: ExamplePlugin(); ~ExamplePlugin(); -//! [plugin methods] +//! [plugin functions] bool initialize(const QStringList &arguments, QString *errorString); void extensionsInitialized(); ShutdownFlag aboutToShutdown(); -//! [plugin methods] +//! [plugin functions] //! [slot] private slots: diff --git a/doc/api/first-plugin.qdoc b/doc/api/first-plugin.qdoc index 0f14611e58..67e5976caa 100644 --- a/doc/api/first-plugin.qdoc +++ b/doc/api/first-plugin.qdoc @@ -276,11 +276,11 @@ All \QC plugins must be derived from \l{ExtensionSystem::IPlugin} and are QObjects. - \snippet exampleplugin/exampleplugin.h plugin methods + \snippet exampleplugin/exampleplugin.h plugin functions - The base class defines basic methods that are called during the life cycle + The base class defines basic functions that are called during the life cycle of a plugin, which are here implemented for your new plugin. - These methods and their roles are described in detail in + These functions and their roles are described in detail in \l{The Plugin Life Cycle}. \snippet exampleplugin/exampleplugin.h slot @@ -296,8 +296,8 @@ All the necessary header files from the plugin code itself, from the Core plugin, and from Qt are included in the beginning of the file. The setup of the menu and menu item - is done in the plugin's \c{initialize} method, which is the first thing called - after the plugin constructor. In that method, the plugin can be sure that the basic + is done in the plugin's \c{initialize} function, which is the first thing called + after the plugin constructor. In that function, the plugin can be sure that the basic setup of plugin's that it depends on has been done, for example the Core plugin's \c{ActionManager} instance has been created. diff --git a/doc/api/plugin-lifecycle.qdoc b/doc/api/plugin-lifecycle.qdoc index 171ab55c35..50e533d833 100644 --- a/doc/api/plugin-lifecycle.qdoc +++ b/doc/api/plugin-lifecycle.qdoc @@ -37,8 +37,8 @@ tracks the state of the plugin. You can get the \l{ExtensionSystem::PluginSpec} instances via the plugin manager's \l{ExtensionSystem::PluginManager::plugins()}{plugins()} - method, or, after a plugin is loaded, through the plugin's - \l{ExtensionSystem::IPlugin::pluginSpec()}{pluginSpec()} method. + function, or, after a plugin is loaded, through the plugin's + \l{ExtensionSystem::IPlugin::pluginSpec()}{pluginSpec()} function. \li Sets the plugins to \c Read state. @@ -61,15 +61,15 @@ \li Sets the plugins to \c Loaded state. - \li Calls the \l{ExtensionSystem::IPlugin::initialize()}{initialize()} methods of - all plugins in the order of the load queue. In the \c initialize method, + \li Calls the \l{ExtensionSystem::IPlugin::initialize()}{initialize()} functions of + all plugins in the order of the load queue. In the \c initialize function, a plugin should make sure that all exported interfaces are set up and available to other plugins. A plugin can assume that plugins they depend on have set up their exported interfaces. For example, the \c Core plugin sets up the \l{Core::ActionManager}, \l{Core::EditorManager} and all other publicly available interfaces, so other plugins can request and use them. - The \l{ExtensionSystem::IPlugin::initialize()}{initialize()} method of a plugin + The \l{ExtensionSystem::IPlugin::initialize()}{initialize()} function of a plugin is a good place for \list \li registering objects in the plugin manager's object pool @@ -82,8 +82,8 @@ \li Sets the plugins to \c Initialized state. \li Calls the \l{ExtensionSystem::IPlugin::extensionsInitialized()}{extensionsInitialized()} - methods of all plugins in \e reverse order of the load queue. After - the \c extensionsInitialized method, a plugin should be fully initialized, set up + functions of all plugins in \e reverse order of the load queue. After + the \c extensionsInitialized function, a plugin should be fully initialized, set up and running. A plugin can assume that plugins that depend on it are fully set up, and can finish the initialization of parts that can be extended by other plugins. For example, the \c Core plugin assumes that all plugins have registered @@ -97,10 +97,10 @@ and afterwards \l{Core::ICore::coreOpened()}{coreOpened()}. After startup, when the event loop of \QC is running, the plugin manager calls - the \l{ExtensionSystem::IPlugin::delayedInitialize()}{delayedInitialize()} methods of all + the \l{ExtensionSystem::IPlugin::delayedInitialize()}{delayedInitialize()} functions of all plugins in \e reverse order of the load queue. The calls are done on the main thread, but separated by a delay of a few milliseconds to ensure responsiveness of \QC. - In the \c delayedInitialize method, a plugin can perform non-critical initialization + In the \c delayedInitialize function, a plugin can perform non-critical initialization that could unnecessarily delay showing the \QC UI if done during startup. After all delayed initializations are done the \l{ExtensionSystem::PluginManager}{PluginManager} @@ -111,14 +111,14 @@ plugin manager starts its shutdown sequence: \list 1 - \li Calls the \l{ExtensionSystem::IPlugin::aboutToShutdown()}{aboutToShutdown()} methods of + \li Calls the \l{ExtensionSystem::IPlugin::aboutToShutdown()}{aboutToShutdown()} functions of all plugins in the order of the load queue. Plugins should perform measures for speeding up the actual shutdown here, like disconnecting signals that would otherwise needlessly be called. If a plugin needs to delay the real shutdown for a while, for example if it needs to wait for external processes to finish for a clean shutdown, the plugin can return \l{ExtensionSystem::IPlugin::AsynchronousShutdown} from this - method. This will make the plugin manager wait with the next step, and keep the main + function. This will make the plugin manager wait with the next step, and keep the main event loop running, until all plugins requesting AsynchronousShutdown have sent the asynchronousShutdownFinished() signal. diff --git a/doc/api/plugin-specifications.qdoc b/doc/api/plugin-specifications.qdoc index acbeca5569..a56bf93b4c 100644 --- a/doc/api/plugin-specifications.qdoc +++ b/doc/api/plugin-specifications.qdoc @@ -199,7 +199,7 @@ \l{The Plugin Manager, the Object Pool, and Registered Objects}{global object pool} via ExtensionSystem::PluginManager::getObjectByName() or ExtensionSystem::PluginManager::getObjectByClassName(), and use QMetaObject functions to call - methods on it. + functions on it. \section2 Command Line Arguments @@ -210,7 +210,7 @@ line parsing and sanity checks based on that information. If the plugin manager finds matching command line arguments for a plugin, it passes them on to the plugin's - \l{ExtensionSystem::IPlugin::initialize()}{initialize()} method. + \l{ExtensionSystem::IPlugin::initialize()}{initialize()} function. All command line argument definitions are enclosed by a single \c argumentList tag. The individual command line arguments are defined by the \c argument tag, diff --git a/doc/api/pluginmanager.qdoc b/doc/api/pluginmanager.qdoc index b74d1210be..e221f90d64 100644 --- a/doc/api/pluginmanager.qdoc +++ b/doc/api/pluginmanager.qdoc @@ -38,13 +38,13 @@ and retrieved depending on different criteria. Most interaction of plugins with the plugin manager should be done through the - ExtensionSystem::IPlugin interface, but the following tables summarize some methods + ExtensionSystem::IPlugin interface, but the following tables summarize some functions and signals that can be useful for plugins. See the ExtensionSystem::PluginManager reference documentation for the complete list. \table \header - \li Method + \li Function \li Description \row \li instance() @@ -97,9 +97,9 @@ All objects of a specified type can be retrieved from the object pool via the \l{ExtensionSystem::PluginManager::getObjects()}{getObjects()} and - \l{ExtensionSystem::PluginManager::getObject()}{getObject()} methods. - They are aware of Aggregation::Aggregate, so these methods use the Aggregation::query() methods - instead of qobject_cast to determine the matching objects. + \l{ExtensionSystem::PluginManager::getObject()}{getObject()} functions. + They are aware of Aggregation::Aggregate, so these functions use the Aggregation::query() + functions instead of qobject_cast to determine the matching objects. It is also possible to retrieve an object with a specific object name with \l{ExtensionSystem::PluginManager::getObjectByName()}{getObjectByName()} diff --git a/doc/api/qtcreator-dev-wizards.qdoc b/doc/api/qtcreator-dev-wizards.qdoc index ca31a35104..08c33e6edd 100644 --- a/doc/api/qtcreator-dev-wizards.qdoc +++ b/doc/api/qtcreator-dev-wizards.qdoc @@ -240,7 +240,7 @@ The complete code of \c webpagewizard.cpp looks as follows: \snippet webpagewizard/webpagewizard.cpp 0 - The registration of the wizard in the \c initialize() method + The registration of the wizard in the \c initialize() function of a plugin looks like: \snippet webpagewizard/webpagewizardplugin.cpp 0 */ diff --git a/doc/src/debugger/creator-debugger.qdoc b/doc/src/debugger/creator-debugger.qdoc index a9636f6c5f..ee81898c39 100644 --- a/doc/src/debugger/creator-debugger.qdoc +++ b/doc/src/debugger/creator-debugger.qdoc @@ -1011,7 +1011,7 @@ easier to employ the Dumper Python class for that purpose. The Dumper Python class contains a complete framework to take care of the \c iname and \c addr fields, to handle children of simple types, references, pointers, - enums, known and unknown structs as well as some convenience methods to + enums, known and unknown structs as well as some convenience functions to handle common situations. The member functions of the \gui{Dumper} class are the following: @@ -1021,7 +1021,7 @@ \li \gui{__init__(self)} - Initializes the output to an empty string and empties the child stack. This should not be used in user code. - \li \gui{put(self, value)} - Low level method to directly append to the + \li \gui{put(self, value)} - Low level function to directly append to the output string. That is also the fastest way to append output. \li \gui{putField(self, name, value)} - Appends a name='value' field. diff --git a/doc/src/editors/creator-coding-edit-mode.qdoc b/doc/src/editors/creator-coding-edit-mode.qdoc index dac877fc12..6ba0eccb44 100644 --- a/doc/src/editors/creator-coding-edit-mode.qdoc +++ b/doc/src/editors/creator-coding-edit-mode.qdoc @@ -151,13 +151,13 @@ You can also select the symbol and press \key F2, or right-click the symbol and select \gui {Follow Symbol Under Cursor} to move to its definition or - declaration. This feature is supported for namespaces, classes, methods, + declaration. This feature is supported for namespaces, classes, functions, variables, include statements, and macros. - To switch between the definition and declaration of a method, place the + To switch between the definition and declaration of a function, place the cursor on either and press \key {Shift+F2} or right-click and select \gui - {Switch Between Method Declaration/Definition}. For example, this allows - you to navigate from anywhere within a method body directly to the method + {Switch Between Function Declaration/Definition}. For example, this allows + you to navigate from anywhere within a function body directly to the function declaration. Links are opened in the same split by default. To open links in the next diff --git a/doc/src/editors/creator-coding.qdoc b/doc/src/editors/creator-coding.qdoc index 60c4541b68..7a2e3aa697 100644 --- a/doc/src/editors/creator-coding.qdoc +++ b/doc/src/editors/creator-coding.qdoc @@ -45,7 +45,7 @@ Use the incremental and advanced search to search from currently open projects or files on the file system or use the locator to - browse through projects, files, classes, methods, documentation and + browse through projects, files, classes, functions, documentation and file systems. \li \l{Refactoring} diff --git a/doc/src/editors/creator-editors.qdoc b/doc/src/editors/creator-editors.qdoc index 01d4c821e4..46fc117eef 100644 --- a/doc/src/editors/creator-editors.qdoc +++ b/doc/src/editors/creator-editors.qdoc @@ -43,7 +43,7 @@ \li Class fields - \li Virtual methods + \li Virtual functions \endlist @@ -1062,9 +1062,9 @@ \li Interpret the \key Tab and \key Backspace key presses. - \li Indent the contents of classes, methods, blocks, and namespaces. + \li Indent the contents of classes, functions, blocks, and namespaces. - \li Indent braces in classes, namespaces, enums, methods, and blocks. + \li Indent braces in classes, namespaces, enums, functions, and blocks. \li Control switch statements and their contents. @@ -1178,14 +1178,14 @@ You can indent public, protected, and private statements and declarations related to them within classes. - You can also indent statements within methods and blocks and declarations + You can also indent statements within functions and blocks and declarations within namespaces. \image qtcreator-code-style-content.png "Content options" \section1 Specifying Settings for Braces - You can indent class, namespace, enum and method declarations and code + You can indent class, namespace, enum and function declarations and code blocks. \image qtcreator-code-style-braces.png "Braces options" @@ -1422,7 +1422,7 @@ \endlist \note You can also select \gui{Edit > Find/Replace > Advanced Find > - C++ Symbols} to search for classes, methods, enums, and declarations + C++ Symbols} to search for classes, functions, enums, and declarations either from files listed as part of the project or from all files that are used by the code, such as include files. @@ -1523,7 +1523,7 @@ \li Create variable declarations - \li Create method declarations and definitions + \li Create function declarations and definitions \endlist @@ -1817,21 +1817,21 @@ } \endcode - \li Method name + \li Function name \row \li Add 'Function' Declaration \li Inserts the member function declaration that matches the member function definition into the class declaration. The function can be public, protected, private, public slot, protected slot, or private slot. - \li Method name + \li Function name \row \li Switch with Next/Previous Parameter \li Moves a parameter down or up one position in a parameter list. - \li Parameter in the declaration or definition of a function or method + \li Parameter in the declaration or definition of a function \row - \li Extract Method - \li Moves the selected code to a new method and replaces the block of - code with a call to the new method. Enter a name for the method in + \li Extract Function + \li Moves the selected code to a new function and replaces the block of + code with a call to the new function. Enter a name for the function in the \gui {Extract Function Refactoring} dialog. \li Block of code selected \row @@ -1875,8 +1875,8 @@ \li Generate Missing Q_PROPERTY Members \li Adds missing members to a Q_PROPERTY: \list - \li \c read method - \li \c write method, if there is a WRITE + \li \c read function + \li \c write function, if there is a WRITE \li \c {onChanged} signal, if there is a NOTIFY \li data member with the name \c {m_<propertyName>} \endlist @@ -2187,7 +2187,7 @@ \endlist Filters locating files also accept paths, such as \c {tools/*main.cpp}. - Filters locating class and method definitions also accept namespaces, + Filters locating class and function definitions also accept namespaces, such as \c {Utils::*View}. By default, the following filters are enabled and you do not need to use diff --git a/doc/src/editors/creator-finding.qdoc b/doc/src/editors/creator-finding.qdoc index d2e0b27883..7c7297982a 100644 --- a/doc/src/editors/creator-finding.qdoc +++ b/doc/src/editors/creator-finding.qdoc @@ -45,7 +45,7 @@ \li \l{Searching with the Locator} The locator provides one of the easiest ways in \QC to browse - through projects, files, classes, methods, documentation and + through projects, files, classes, functions, documentation and file systems. \endlist diff --git a/doc/src/howto/creator-keyboard-shortcuts.qdoc b/doc/src/howto/creator-keyboard-shortcuts.qdoc index a428373e85..b01fa6bbe8 100644 --- a/doc/src/howto/creator-keyboard-shortcuts.qdoc +++ b/doc/src/howto/creator-keyboard-shortcuts.qdoc @@ -391,14 +391,14 @@ \row \li Follow symbol under cursor - Works with namespaces, classes, methods, variables, include + Works with namespaces, classes, functions, variables, include statements and macros \li F2 \row \li Rename symbol under cursor \li Ctrl+Shift+R \row - \li Switch between method declaration and definition + \li Switch between function declaration and definition \li Shift+F2 \row \li Open type hierarchy diff --git a/doc/src/howto/creator-tips.qdoc b/doc/src/howto/creator-tips.qdoc index 781cf1a2a8..421b9414e6 100644 --- a/doc/src/howto/creator-tips.qdoc +++ b/doc/src/howto/creator-tips.qdoc @@ -212,7 +212,7 @@ \section1 Locating Files The \gui Locator provides one of the easiest ways in \QC to browse - through projects, files, classes, methods, documentation and file systems. + through projects, files, classes, functions, documentation and file systems. To quickly access files not directly mentioned in your project, you can create your own locator filters. That way you can locate files in a directory structure you have defined. diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index 880de704db..07bbce7ab2 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -56,7 +56,7 @@ output panes (7). You can use the locator (6) to to browse through projects, files, classes, - methods, documentation, and file systems. + functions, documentation, and file systems. \section1 Modes diff --git a/doc/src/howto/qtcreator-faq.qdoc b/doc/src/howto/qtcreator-faq.qdoc index 77b500343e..965650ad66 100644 --- a/doc/src/howto/qtcreator-faq.qdoc +++ b/doc/src/howto/qtcreator-faq.qdoc @@ -281,17 +281,17 @@ The locator can be used to open files, but opening files is also just a step on the way to accomplish a task. For example, consider the following - use case: \e {Fix AMethod in SomeClass which comes from + use case: \e {Fix AFunction in SomeClass which comes from someclass.cpp/someclass.h}. With a tabbed user interface, developers would search for someclass.cpp in - the tab bar, and then search for \c {::AMethod}, only to find out that the - method is not located in that file. They would then search for someclass.h + the tab bar, and then search for \c {::AFunction}, only to find out that the + function is not located in that file. They would then search for someclass.h in the tab bar, find our that the function is inline, fix the problem, and forget where they came from. - With \QC, developers can type \c {Ctrl+K m AMet} to find the method. - Typically, they only need to type 3 to 4 characters of the method name. + With \QC, developers can type \c {Ctrl+K m AFun} to find the function. + Typically, they only need to type 3 to 4 characters of the function name. They can then fix the problem and press \key Alt+Back to go back to where they were. |