feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Use hyphenated form of "command-line" where appropriate

Browse Source 
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
This commit is contained in:
Leena Miettinen
2023-09-13 10:56:54 +02:00
parent 9c036fe393
commit 6cf4b1a3cd
36 changed files with 57 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/qtcreator/config/style/qt5-sidebar.html
View File

@@ -100,7 +100,7 @@
<ul> <ul>
<li><a href="creator-acknowledgements.html">Acknowledgements</a></li> <li><a href="creator-acknowledgements.html">Acknowledgements</a></li>
<li><a href="creator-project-other.html">Build Systems</a></li> <li><a href="creator-project-other.html">Build Systems</a></li>
<li><a href="creator-cli.html">Command Line Options</a></li> <li><a href="creator-cli.html">Command-Line Options</a></li>
<li><a href="creator-project-wizards.html">Custom Wizards</a></li> <li><a href="creator-project-wizards.html">Custom Wizards</a></li>
<li><a href="creator-faq.html">FAQ</a></li> <li><a href="creator-faq.html">FAQ</a></li>
<li><a href="creator-glossary.html">Glossary</a></li> <li><a href="creator-glossary.html">Glossary</a></li>

4
doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc
View File

@@ -219,9 +219,9 @@
snapshots may fail to capture call chains of highly recursive applications snapshots may fail to capture call chains of highly recursive applications
or other intense stack usage. or other intense stack usage.
\section2 Adding Command Line Options For Perf \section2 Adding Command-Line Options for Perf
You can specify additional command line options to be passed to Perf when You can specify additional command-line options to be passed to Perf when
recording data in the \uicontrol {Additional arguments} field. You may want recording data in the \uicontrol {Additional arguments} field. You may want
to specify \c{--no-delay} or \c{--no-buffering} to reduce the processing to specify \c{--no-delay} or \c{--no-buffering} to reduce the processing
delay. However, those options are not supported by all versions of Perf and delay. However, those options are not supported by all versions of Perf and

2
doc/qtcreator/src/android/androiddev.qdoc
View File

@@ -21,7 +21,7 @@
highlighting, function tooltips, and navigating in code, add a highlighting, function tooltips, and navigating in code, add a
\l{Java Language Server}{Java language server}. \l{Java Language Server}{Java language server}.
\QC integrates the Android Debug Bridge (\c adb) command line tool for \QC integrates the Android Debug Bridge (\c adb) command-line tool for
deploying applications to Android devices, running them, and reading their deploying applications to Android devices, running them, and reading their
logs. The \c adb tool includes a client and server that run on logs. The \c adb tool includes a client and server that run on
the development host and a daemon that runs on the emulator or device. the development host and a daemon that runs on the emulator or device.

2
doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc
View File

@@ -178,7 +178,7 @@
32-bit executable with a 64-bit debugger can result in a stack trace of the 32-bit executable with a 64-bit debugger can result in a stack trace of the
WOW64 emulator 32-bit emulation layer being displayed. WOW64 emulator 32-bit emulation layer being displayed.
\QC extends the command line debugger by loading the \QC extends the command-line debugger by loading the
\c qtcreatorcdbext.dll extension library into it. The \c qtcreatorcdbext.dll extension library into it. The
library must be available in the \c {libs\qtcreatorcdbext64} library must be available in the \c {libs\qtcreatorcdbext64}
and \c {libs\qtcreatorcdbext32} folder. To install it there, and \c {libs\qtcreatorcdbext32} folder. To install it there,

6
doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
View File

@@ -390,7 +390,7 @@
\endlist \endlist
For more information, see \l{Command Line Options}. For more information, see \l{Command-Line Options}.
*/ */
/*! /*!
@@ -497,14 +497,14 @@
\section1 Using CDB \section1 Using CDB
In remote mode, the local CDB process talks to a CDB process that runs on In remote mode, the local CDB process talks to a CDB process that runs on
the remote machine. The process is started with special command line options the remote machine. The process is started with special command-line options
that switch it into server mode. The remote CDB process must load the \QC that switch it into server mode. The remote CDB process must load the \QC
CDB extension library that is shipped with \QC: CDB extension library that is shipped with \QC:
\list 1 \list 1
\li Install the \e{Debugging Tools for Windows} on the remote machine. \li Install the \e{Debugging Tools for Windows} on the remote machine.
The installation folder has the CDB command line executable The installation folder has the CDB command-line executable
(\c cdb.exe). (\c cdb.exe).
\li Copy the \QC CDB extension library and the dependencies from the Qt installation \li Copy the \QC CDB extension library and the dependencies from the Qt installation

2
doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
View File

@@ -66,7 +66,7 @@
\li Wrap line movement, such as \c gj, \c gk, \c g0, \c g^, \c g$ \li Wrap line movement, such as \c gj, \c gk, \c g0, \c g^, \c g$
\endlist \endlist
\section2 Command Line Mode \section2 Command-Line Mode
\list \list
\li \c :map, \c :unmap, \c :inoremap, and so on \li \c :map, \c :unmap, \c :inoremap, and so on

2
doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc
View File

@@ -100,7 +100,7 @@
request. request.
\li In the \uicontrol Executable field, enter the path to the language \li In the \uicontrol Executable field, enter the path to the language
server executable. server executable.
\li In the \uicontrol Arguments field, enter any required command line \li In the \uicontrol Arguments field, enter any required command-line
arguments. Select \uicontrol Variables to use variables as arguments. Select \uicontrol Variables to use variables as
arguments. arguments.
\endlist \endlist

2
doc/qtcreator/src/howto/creator-external-tools.qdoc
View File

@@ -157,7 +157,7 @@
{Qt6::LinguistTools}. {Qt6::LinguistTools}.
By default, the project .pro file is passed to the tools as an argument. To By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \uicontrol Tools > specify other command-line arguments for the tools, select \uicontrol Tools >
\uicontrol External > \uicontrol Configure. \uicontrol External > \uicontrol Configure.
\section2 Synchronize TS files \section2 Synchronize TS files

8
doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
View File

@@ -13,11 +13,11 @@
\ingroup creator-reference \ingroup creator-reference
\title Command Line Options \title Command-Line Options
\brief Options for starting \QC from the command line. \brief Options for starting \QC from the command line.
To specify command line options, enter the following command in the To specify command-line options, enter the following command in the
directory that contains the \QC executable or specify the path to directory that contains the \QC executable or specify the path to
\QC as a part of the command: \QC as a part of the command:
@@ -34,7 +34,7 @@
\row \row
\li -help \li -help
\li Display help on command line options. \li Display help on command-line options.
\row \row
\li -version \li -version
@@ -212,7 +212,7 @@
\section1 Using Custom Styles \section1 Using Custom Styles
\QC is a \l{QApplication}{Qt application}, and therefore, it accepts the \QC is a \l{QApplication}{Qt application}, and therefore, it accepts the
command line options that all Qt applications accept. For example, you can command-line options that all Qt applications accept. For example, you can
use the \c {-style} and \c {-stylesheet} options to apply custom styles and use the \c {-style} and \c {-stylesheet} options to apply custom styles and
\l{Qt Style Sheets}{stylesheets}. The styling is only applied during the \l{Qt Style Sheets}{stylesheets}. The styling is only applied during the
current session. current session.

7
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -68,6 +68,7 @@
\li \l {Activate kits for a project} \li \l {Activate kits for a project}
\li \l {Develop Qt for Python applications} \li \l {Develop Qt for Python applications}
\li \l {Open projects} \li \l {Open projects}
\li \l {Specify editor settings}
\li \l {Specify project contents} \li \l {Specify project contents}
\endlist \endlist
\endtable \endtable
@@ -187,7 +188,7 @@
You can start \QC and specify some options from the command line. For You can start \QC and specify some options from the command line. For
example, you can open a file to any line and column. example, you can open a file to any line and column.
To use command line options, enter the following command in the To use command-line options, enter the following command in the
directory that contains the \QC executable or specify the path to directory that contains the \QC executable or specify the path to
\QC as a part of the command: \QC as a part of the command:
@@ -224,7 +225,7 @@
\section1 Open a project from a directory \section1 Open a project from a directory
To open a project that is located in a particular directory, you can To open a project that is located in a particular directory, you can
pass on the directory name as a command line argument. \QC looks for pass on the directory name as a command-line argument. \QC looks for
a \l{Managing Sessions}{session} that matches the directory name and a \l{Managing Sessions}{session} that matches the directory name and
loads it. Or it looks for a project file in the directory and opens it. loads it. Or it looks for a project file in the directory and opens it.
@@ -232,7 +233,7 @@
\c {C:\qtcreator\bin>qtcreator.exe C:\Examples\alarms} \c {C:\qtcreator\bin>qtcreator.exe C:\Examples\alarms}
\sa {Command Line Options} \sa {Command-Line Options}
*/ */
/*! /*!

2
doc/qtcreator/src/howto/creator-sessions.qdoc
View File

@@ -96,7 +96,7 @@
When you start \QC from the command line, you can give the name of When you start \QC from the command line, you can give the name of
a session as an argument and \QC will start with this session. a session as an argument and \QC will start with this session.
For more information, see \l{Command Line Options}. For more information, see \l{Command-Line Options}.
\endif \endif
*/ */

2
doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc
View File

@@ -32,7 +32,7 @@
The build errors and warnings are parsed and displayed in \l Issues. The build errors and warnings are parsed and displayed in \l Issues.
Select the \uicontrol {Keep original jobs number} check box to stop Select the \uicontrol {Keep original jobs number} check box to stop
IncrediBuild from overriding the \c {-j} command line switch, which IncrediBuild from overriding the \c {-j} command-line switch, which
controls the number of processes that the build tools executed by controls the number of processes that the build tools executed by
\QC run in parallel. The default value set by IncrediBuild is 200. \QC run in parallel. The default value set by IncrediBuild is 200.

2
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -98,7 +98,7 @@
\section1 QNX \section1 QNX
The QNX Neutrino RTOS has more command line tools The QNX Neutrino RTOS has more command-line tools
and services, as described in \l {Qt for QNX}. and services, as described in \l {Qt for QNX}.
\note In Qt 6, \QC support for QNX is considered experimental. \note In Qt 6, \QC support for QNX is considered experimental.

2
doc/qtcreator/src/projects/creator-only/creator-custom-output-parser.qdoc
View File

@@ -8,7 +8,7 @@
\title Using Custom Output Parsers \title Using Custom Output Parsers
Custom output parsers scan command line output for error Custom output parsers scan command-line output for error
and warning patterns that you specify and create entries and warning patterns that you specify and create entries
for found patterns in \l Issues. for found patterns in \l Issues.

2
doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc
View File

@@ -146,7 +146,7 @@
/global/genericfilewizard.png" not found. /global/genericfilewizard.png" not found.
\endcode \endcode
See \l{Command Line Options} for more information about command line See \l{Command-Line Options} for more information about command-line
arguments. arguments.
\include creator-projects-custom-wizards-json.qdocinc json wizards \include creator-projects-custom-wizards-json.qdocinc json wizards

2
doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc
View File

@@ -127,7 +127,7 @@
\section1 Forwarding Flags to Clang Code Model \section1 Forwarding Flags to Clang Code Model
The \c {.cxxflags} and \c {.cflags} files have command line flags for the The \c {.cxxflags} and \c {.cflags} files have command-line flags for the
Clang code model on a single line. Clang code model on a single line.
For example, specify the \c {-std=c++11} to set the language version For example, specify the \c {-std=c++11} to set the language version

2
doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc
View File

@@ -121,7 +121,7 @@
setup with \QC. setup with \QC.
\list 1 \list 1
\li qmake is an executable that understands the \c -query command line \li qmake is an executable that understands the \c -query command-line
argument. argument.
\li The \c bin and \c include directories have to exist. \QC fetches \li The \c bin and \c include directories have to exist. \QC fetches
these directories by running \c{qmake -query}. these directories by running \c{qmake -query}.

2
doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc
View File

@@ -90,7 +90,7 @@
\QC executes external processes to accomplish tasks such as building \QC executes external processes to accomplish tasks such as building
and running applications. To execute the processes, \QC uses shell and running applications. To execute the processes, \QC uses shell
commands that are native to the system. It constructs the commands from commands that are native to the system. It constructs the commands from
an executable name and optional command line arguments. an executable name and optional command-line arguments.
The executable name is specified in the executable fields: \uicontrol qmake, The executable name is specified in the executable fields: \uicontrol qmake,
\uicontrol Make, \uicontrol Command, or \uicontrol Executable. It is either \uicontrol Make, \uicontrol Command, or \uicontrol Executable. It is either

2
doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc
View File

@@ -6,7 +6,7 @@
\section1 Specifying Run Settings for Desktop Device Types \section1 Specifying Run Settings for Desktop Device Types
You can specify command line arguments to be passed to the executable You can specify command-line arguments to be passed to the executable
and the working directory to use. The working directory defaults to and the working directory to use. The working directory defaults to
the directory of the build result. the directory of the build result.

2
doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc
View File

@@ -127,7 +127,7 @@
run configuration for your project. For example, when working on a library, run configuration for your project. For example, when working on a library,
you can run a test application that links against the library. you can run a test application that links against the library.
Specify the executable to run, command line arguments, working directory, Specify the executable to run, command-line arguments, working directory,
and environment variables to use. and environment variables to use.
\image qmldesigner-run-custom-exe.png {Run settings for custom executables} \image qmldesigner-run-custom-exe.png {Run settings for custom executables}

2
doc/qtcreator/src/python/creator-python-run.qdocinc
View File

@@ -34,7 +34,7 @@
\li In the \uicontrol Script field, you can see the path to the \li In the \uicontrol Script field, you can see the path to the
main file of the project that will be run. main file of the project that will be run.
\li In the \uicontrol {Command line arguments} field, specify \li In the \uicontrol {Command line arguments} field, specify
command line arguments to be passed to the executable. command-line arguments to be passed to the executable.
\endlist \endlist
If you want to run some other Python file than \c main.py, create a custom If you want to run some other Python file than \c main.py, create a custom

2
doc/qtcreator/src/qnx/creator-developing-qnx.qdoc
View File

@@ -11,7 +11,7 @@
You can connect QNX devices to the development PC to deploy, run and debug You can connect QNX devices to the development PC to deploy, run and debug
applications on them from within \QC. The QNX Neutrino RTOS has additional applications on them from within \QC. The QNX Neutrino RTOS has additional
command line tools and services, as described in \l {Qt for QNX}. command-line tools and services, as described in \l {Qt for QNX}.
\note In Qt 6, \QC support for QNX is considered experimental. \note In Qt 6, \QC support for QNX is considered experimental.

2
doc/qtcreator/src/qnx/creator-projects-running-qnx.qdocinc
View File

@@ -28,7 +28,7 @@
\section2 Troubleshooting Errors \section2 Troubleshooting Errors
To support running, debugging, and stopping applications from \QC, the QNX To support running, debugging, and stopping applications from \QC, the QNX
Neutrino RTOS has additional command line tools and services, as described Neutrino RTOS has additional command-line tools and services, as described
in \l {Qt for QNX}. in \l {Qt for QNX}.
\section3 Debug Output Cannot Be Shown \section3 Debug Output Cannot Be Shown

2
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -272,7 +272,7 @@
\li \l{Reference} \li \l{Reference}
\list \list
\li \l {Acknowledgements} \li \l {Acknowledgements}
\li \l {Command Line Options} \li \l {Command-Line Options}
\li \l {Custom Wizards} \li \l {Custom Wizards}
\li \l {FAQ} \li \l {FAQ}
\li \l {Glossary} \li \l {Glossary}

2
doc/qtcreator/src/qtcreator.qdoc
View File

@@ -103,7 +103,7 @@
\li \b {\l{Reference}} \li \b {\l{Reference}}
\list \list
\li \l {Build Systems} \li \l {Build Systems}
\li \l {Command Line Options} \li \l {Command-Line Options}
\li \l {Custom Wizards} \li \l {Custom Wizards}
\li \l {Keyboard Shortcuts} \li \l {Keyboard Shortcuts}
\li \l {Supported Platforms} \li \l {Supported Platforms}

2
doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc
View File

@@ -119,7 +119,7 @@
\image qtcreator-application-output.webp {Application Output} \image qtcreator-application-output.webp {Application Output}
\if defined(qtcreator) \if defined(qtcreator)
If you specify command line arguments in the run settings that are passed If you specify command-line arguments in the run settings that are passed
to the application when running it, they are displayed as a part of the to the application when running it, they are displayed as a part of the
application output. For more information, see application output. For more information, see
\l{Specifying Run Settings for Desktop Device Types}. \l{Specifying Run Settings for Desktop Device Types}.

2
doc/qtcreator/src/vcs/creator-only/creator-vcs-bazaar.qdoc
View File

@@ -52,7 +52,7 @@
\image qtcreator-preferences-vcs-bazaar.webp {Bazaar preferences} \image qtcreator-preferences-vcs-bazaar.webp {Bazaar preferences}
\list \list
\li \uicontrol Command specifies the path to the command line client \li \uicontrol Command specifies the path to the command-line client
executable. executable.
\li \uicontrol {Default username} and \uicontrol {Default email} \li \uicontrol {Default username} and \uicontrol {Default email}
specify the username and email address to use by default when specify the username and email address to use by default when

2
doc/qtcreator/src/vcs/creator-only/creator-vcs-cvs.qdoc
View File

@@ -40,7 +40,7 @@
\image qtcreator-preferences-vcs-cvs.webp {CVS preferences} \image qtcreator-preferences-vcs-cvs.webp {CVS preferences}
\list \list
\li \uicontrol {CVS Command} specifies the path to the command line \li \uicontrol {CVS Command} specifies the path to the command-line
client executable. client executable.
\li \uicontrol {CVS root} specifies the CVS root. \li \uicontrol {CVS root} specifies the CVS root.
\li \uicontrol Timeout sets a timeout for version control operations. \li \uicontrol Timeout sets a timeout for version control operations.

2
doc/qtcreator/src/vcs/creator-only/creator-vcs-fossil.qdoc
View File

@@ -75,7 +75,7 @@
\uicontrol {Version Control} > \uicontrol Fossil: \uicontrol {Version Control} > \uicontrol Fossil:
\list \list
\li \uicontrol Command specifies the path to the command line client \li \uicontrol Command specifies the path to the command-line client
executable. executable.
\li \uicontrol {Default path} sets the path to the directory to store \li \uicontrol {Default path} sets the path to the directory to store
local repositories by default. local repositories by default.

2
doc/qtcreator/src/vcs/creator-only/creator-vcs-mercurial.qdoc
View File

@@ -54,7 +54,7 @@
\image qtcreator-preferences-vcs-mercurial.webp {Mercurial preferences} \image qtcreator-preferences-vcs-mercurial.webp {Mercurial preferences}
\list \list
\li \uicontrol Command specifies the path to the command line client \li \uicontrol Command specifies the path to the command-line client
executable. executable.
\li \uicontrol {Default username} and \uicontrol {Default email} \li \uicontrol {Default username} and \uicontrol {Default email}
specify the username and email address to use by default when specify the username and email address to use by default when

2
doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
View File

@@ -37,7 +37,7 @@
\image qtcreator-preferences-vcs-perforce.webp {Perforce preferences} \image qtcreator-preferences-vcs-perforce.webp {Perforce preferences}
In \uicontrol {P4 command}, set the path to the command line client In \uicontrol {P4 command}, set the path to the command-line client
executable. executable.
Set workspace details in \uicontrol {P4 user}, \uicontrol {P4 client}, and Set workspace details in \uicontrol {P4 user}, \uicontrol {P4 client}, and

6
doc/qtcreator/src/vcs/creator-only/creator-vcs-preferences.qdoc
View File

@@ -9,9 +9,9 @@
\title Set up version control systems \title Set up version control systems
\QC uses the version control system's command line clients to access your \QC uses the version control system's command-line clients to access your
repositories. Make sure that the command line clients are in the \c{PATH} repositories. Make sure that the command-line clients are in the \c{PATH}
environment variable, or specify the path to the command line client environment variable, or specify the path to the command-line client
executable in the version control system specific tab in \uicontrol Edit > executable in the version control system specific tab in \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Version Control}. \uicontrol Preferences > \uicontrol {Version Control}.

2
doc/qtcreatordev/src/external-tool-spec.qdoc
View File

@@ -139,7 +139,7 @@
finds. Required. finds. Required.
\row \row
\li arguments \li arguments
\li Command line arguments for the executable. Specify the string in the \li Command-line arguments for the executable. Specify the string in the
same format (with respect to quoting and argument splitting, for same format (with respect to quoting and argument splitting, for
example) as you would specify it on the command line of the platform example) as you would specify it on the command line of the platform
the tool runs on. Optional. the tool runs on. Optional.

22
doc/qtcreatordev/src/plugin-metadata.qdoc
View File

@@ -215,7 +215,7 @@
\section3 Test Dependencies \section3 Test Dependencies
When the user runs the application with the \c{-test} command line argument, only When the user runs the application with the \c{-test} command-line argument, only
the specified plugins and their dependencies are loaded. This is done in order to the specified plugins and their dependencies are loaded. This is done in order to
speed up the execution of tests by avoiding the loading of unneeded plugins. speed up the execution of tests by avoiding the loading of unneeded plugins.
@@ -225,18 +225,18 @@
This type of dependency is not transitive. This type of dependency is not transitive.
\section2 Command Line Arguments \section2 Command-Line Arguments
Plugins can register command line arguments that the user can give Plugins can register command-line arguments that the user can give
when starting the application. These command line arguments are shown when starting the application. These command-line arguments are shown
with a one-line description when the user runs the application with with a one-line description when the user runs the application with
the \c{-help} command line argument, and the plugin manager does its command the \c{-help} command-line argument, and the plugin manager does its command
line parsing and sanity checks based on that information. line parsing and sanity checks based on that information.
If the plugin manager finds matching command line arguments for a plugin, If the plugin manager finds matching command-line arguments for a plugin,
it passes them on to the plugin's it passes them on to the plugin's
\l{ExtensionSystem::IPlugin::initialize()}{initialize()} function. \l{ExtensionSystem::IPlugin::initialize()}{initialize()} function.
Command line arguments are defined through the key \c Arguments, which contains an array Command-line arguments are defined through the key \c Arguments, which contains an array
of argument objects. Each individual argument object has the required key \c Name, and of argument objects. Each individual argument object has the required key \c Name, and
optional keys \c Parameter and \c Description. optional keys \c Parameter and \c Description.
@@ -248,7 +248,7 @@
\row \row
\li Arguments \li Arguments
\li Array of argument objects \li Array of argument objects
\li Describes the command line arguments that the plugin wants to handle. \li Describes the command-line arguments that the plugin wants to handle.
\endtable \endtable
An argument object is a JSON object with the following keys: An argument object is a JSON object with the following keys:
@@ -260,19 +260,19 @@
\row \row
\li Name \li Name
\li String \li String
\li The command line argument itself, including the \c - prefix, e.g. \li The command-line argument itself, including the \c - prefix, e.g.
\c{-my-parameter}. \c{-my-parameter}.
\row \row
\li Parameter \li Parameter
\li String \li String
\li Optional. If this is given, the command line argument expects an \li Optional. If this is given, the command-line argument expects an
additional parameter, e.g. \c{-my-parameter somevalue}. The additional parameter, e.g. \c{-my-parameter somevalue}. The
value of this attribute is used as a very short description of the value of this attribute is used as a very short description of the
parameter for the user. parameter for the user.
\row \row
\li Description \li Description
\li String \li String
\li Optional. A (one-line) description of the argument for the command line argument help. \li Optional. A (one-line) description of the argument for the command-line argument help.
\endtable \endtable
\section2 Example \c Test.json \section2 Example \c Test.json

2
doc/qtcreatordev/src/plugin-tests.qdoc
View File

@@ -31,7 +31,7 @@
test. test.
Plugin tests are executed by starting \QC with the \c{-test <pluginname>} Plugin tests are executed by starting \QC with the \c{-test <pluginname>}
command line argument. \QC then fully loads your plugin and all the plugins command-line argument. \QC then fully loads your plugin and all the plugins
that it depends on, going through the normal \l{Plugin Life Cycle}. After that it depends on, going through the normal \l{Plugin Life Cycle}. After
your plugin and all dependencies are fully initialized, your tests are your plugin and all dependencies are fully initialized, your tests are
executed. Afterwards, \QC automatically closes. Therefore, your plugin executed. Afterwards, \QC automatically closes. Therefore, your plugin

2
doc/qtcreatordev/src/pluginmanager.qdoc
View File

@@ -16,7 +16,7 @@
The plugin manager handles all the details regarding finding plugins, reading their The plugin manager handles all the details regarding finding plugins, reading their
description files, resolving plugin dependencies, loading and initializing all plugins description files, resolving plugin dependencies, loading and initializing all plugins
in the right order, and passing on command line arguments. in the right order, and passing on command-line arguments.
In addition, the plugin manager manages an \e{object pool}, where objects can be registered In addition, the plugin manager manages an \e{object pool}, where objects can be registered
and retrieved depending on different criteria. and retrieved depending on different criteria.