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

Doc: replace deprecated QDoc commands

Browse Source 
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:
Leena Miettinen
2013-02-06 08:50:23 +01:00
committed by Oswald Buddenhagen
parent 276320caac
commit 419c6de735
133 changed files with 2773 additions and 2773 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
doc/src/howto/creator-cli.qdoc
View File

@@ -46,11 +46,11 @@
\list
\o \c {C:\qtcreator\bin>qtcreator -help}
\li \c {C:\qtcreator\bin>qtcreator -help}
\o \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100}
\li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100}
\o \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100}
\li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100}
\endlist
@@ -64,55 +64,55 @@
\table
\header
\o Option
\o Description
\li Option
\li Description
\row
\o -help
\o Display help on command line options.
\li -help
\li Display help on command line options.
\row
\o -version
\o Display \QC version.
\li -version
\li Display \QC version.
\row
\o -client
\o Attempt to connect to an already running instance of \QC.
\li -client
\li Attempt to connect to an already running instance of \QC.
\row
\o -noload <plugin>
\o Do not load the specified plugin.
\li -noload <plugin>
\li Do not load the specified plugin.
\row
\o -profile
\o Output plugin start up and shut down profiling data.
\li -profile
\li Output plugin start up and shut down profiling data.
\row
\o -settingspath <path>
\o Override the default path where user settings are stored.
\li -settingspath <path>
\li Override the default path where user settings are stored.
\row
\o -color <color>
\o Core plugin: override the selected UI color.
\li -color <color>
\li Core plugin: override the selected UI color.
\row
\o -debug <PID-or-corefile>
\o Debugger plugin: attach to process ID or core file.
\li -debug <PID-or-corefile>
\li Debugger plugin: attach to process ID or core file.
\row
\o -wincrashevent <event-handle>
\o Debugger plugin: Attach to crashed processes by using the specified
\li -wincrashevent <event-handle>
\li Debugger plugin: Attach to crashed processes by using the specified
event handle.
\row
\o -customwizard-verbose
\o ProjectExplorer plugin: display additional information when loading
\li -customwizard-verbose
\li ProjectExplorer plugin: display additional information when loading
custom wizards. For more information about custom wizards, see
\l{Adding New Custom Wizards}
\row
\o -lastsession
\o ProjectExplorer plugin: load the last session when \QC starts.
\li -lastsession
\li ProjectExplorer plugin: load the last session when \QC starts.
Open the projects and files that were open when you last exited \QC.
For more information about managing sessions, see \l{Managing Sessions}.

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

@@ -103,31 +103,31 @@
\list 1
\o Select \gui {Tools > External > Configure}.
\li Select \gui {Tools > External > Configure}.
\o Select \gui {Add > Add Tool}
\li Select \gui {Add > Add Tool}
to add a new tool. You can also select \gui {Add Category} to add a
new category.
\o In the \gui Executable field, specify the executable to run. If the
\li In the \gui Executable field, specify the executable to run. If the
executable is found in your system PATH variable, do not specify
the path to it.
\o In the \gui Arguments field, specify optional arguments for running
\li In the \gui Arguments field, specify optional arguments for running
the executable.
\o In the \gui {Working directory} field, specify the path to the
\li In the \gui {Working directory} field, specify the path to the
working directory.
\o In the \gui {Output pane}, select how to handle output from the
\li In the \gui {Output pane}, select how to handle output from the
tool. You can ignore the output, view it in the \gui {General
Messages} output pane, or replace the selected text with the
output in the code editor.
\o In the \gui {Error output pane}, select how to handle error messages
\li In the \gui {Error output pane}, select how to handle error messages
from the tool.
\o In the \gui Input field, specify text that is passed as standard
\li In the \gui Input field, specify text that is passed as standard
input to the tool.
\endlist

44
doc/src/howto/creator-help.qdoc
View File

@@ -35,19 +35,19 @@
\list
\o To view documentation, switch to \gui Help mode.
\li To view documentation, switch to \gui Help mode.
\o To view context sensitive help on a Qt class or function as a
\li To view context sensitive help on a Qt class or function as a
tooltip, move the mouse cursor over the class or function. If help
is not available, the tooltip displays type information for the
symbol.
\o To display the full help on a Qt class or function, press \key F1.
\li To display the full help on a Qt class or function, press \key F1.
The documentation is displayed in a
pane next to the code editor, or, if there is not enough vertical
space, in the fullscreen \gui Help mode.
\o To select and configure how the documentation is displayed in the
\li To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options > \gui Help.
\endlist
@@ -75,19 +75,19 @@
\list
\o \gui Bookmarks to view a list of pages on which you have added
\li \gui Bookmarks to view a list of pages on which you have added
bookmarks.
\o \gui Contents to see all the documentation installed on the
\li \gui Contents to see all the documentation installed on the
development PC and to browse the documentation contents.
\o \gui Index to find information based on a list of keywords in all
\li \gui Index to find information based on a list of keywords in all
the installed documents.
\o \gui {Open Pages} to view a list of currently open documentation
\li \gui {Open Pages} to view a list of currently open documentation
pages.
\o \gui Search to search from all the installed documents.
\li \gui Search to search from all the installed documents.
\endlist
@@ -104,11 +104,11 @@
\list 1
\o Click the
\li Click the
\inlineimage qtcreator-help-add-bookmark.png
(\gui {Add Bookmark}) button on the toolbar.
\o In the \gui {Add Bookmark} dialog, click \gui OK to save the
\li In the \gui {Add Bookmark} dialog, click \gui OK to save the
page title as a bookmark in the \gui Bookmarks folder.
\endlist
@@ -131,16 +131,16 @@
\list
\o \c deep lists all the documents that contain the word \c deep.
\li \c deep lists all the documents that contain the word \c deep.
The search is not case sensitive.
\o \c{deep*} lists all the documents that contain a word beginning
\li \c{deep*} lists all the documents that contain a word beginning
with \c deep
\o \c{deep copy} lists all documents that contain both \c deep and
\li \c{deep copy} lists all documents that contain both \c deep and
\c copy
\o \c{"deep copy"} lists all documents that contain the phrase
\li \c{"deep copy"} lists all documents that contain the phrase
\c{deep copy}
\endlist
@@ -172,14 +172,14 @@
\list 1
\o Create a .qch file from your documentation.
\li Create a .qch file from your documentation.
For information on how to prepare your documentation and create a
.qch file, see
\l{http://qt-project.org/doc/qt-4.8/qthelp-framework.html}
{The Qt Help Framework}.
\o To add the .qch file to \QC, select \gui Tools > \gui Options >
\li To add the .qch file to \QC, select \gui Tools > \gui Options >
\gui Help > \gui Documentation > \gui Add.
\endlist
@@ -232,18 +232,18 @@
\list 1
\o Select \gui {Tools > Options > Help > Filters > Add}.
\li Select \gui {Tools > Options > Help > Filters > Add}.
\o Enter a name for the filter and press \gui {OK}.
\li Enter a name for the filter and press \gui {OK}.
\o In \gui Attributes, select the documents that you want to include
\li In \gui Attributes, select the documents that you want to include
in the filter.
\image qtcreator-help-filter-attributes.png "Help filter attributes"
\o Click \gui OK.
\li Click \gui OK.
\o In the \gui Help mode, select the filter in the \gui {Filtered by}
\li In the \gui Help mode, select the filter in the \gui {Filtered by}
field to see the filtered documentation in the sidebar.
\endlist

782
doc/src/howto/creator-keyboard-shortcuts.qdoc
View File

File diff suppressed because it is too large Load Diff

8
doc/src/howto/creator-sessions.qdoc
View File

@@ -38,13 +38,13 @@
\list
\o Open projects with their dependencies (including SUBDIRS projects)
\li Open projects with their dependencies (including SUBDIRS projects)
\o Open editors
\li Open editors
\o Breakpoints and expressions
\li Breakpoints and expressions
\o Bookmarks
\li Bookmarks
\endlist

14
doc/src/howto/creator-task-lists.qdoc
View File

@@ -61,13 +61,13 @@
\list
\o \c description
\li \c description
\o \c{type\tdescription}
\li \c{type\tdescription}
\o \c{file\ttype\tdescription}
\li \c{file\ttype\tdescription}
\o \c{file\tline\ttype\tdescription}
\li \c{file\tline\ttype\tdescription}
\endlist
@@ -75,12 +75,12 @@
\list
\o A string starting with \c err, which displays the error icon in the
\li A string starting with \c err, which displays the error icon in the
beginning of the line
\o A string starting with \c warn, which displays the warning icon
\li A string starting with \c warn, which displays the warning icon
\o Any other value, which sets the task type to Unknown and does not
\li Any other value, which sets the task type to Unknown and does not
display an icon
\endlist

50
doc/src/howto/creator-tips.qdoc
View File

@@ -37,13 +37,13 @@
\list
\o \gui Welcome mode \key Ctrl+1
\o \gui Edit mode \key Ctrl+2
\o \gui Design mode \key Ctrl+3
\o \gui Debug mode \key Ctrl+4
\o \gui Projects mode \key Ctrl+5
\o \gui Analyze mode \key Ctrl+6
\o \gui Help mode \key Ctrl+7
\li \gui Welcome mode \key Ctrl+1
\li \gui Edit mode \key Ctrl+2
\li \gui Design mode \key Ctrl+3
\li \gui Debug mode \key Ctrl+4
\li \gui Projects mode \key Ctrl+5
\li \gui Analyze mode \key Ctrl+6
\li \gui Help mode \key Ctrl+7
\endlist
@@ -69,9 +69,9 @@
\list
\o The first press moves focus to the editor
\li The first press moves focus to the editor
\o The second press closes secondary windows
\li The second press closes secondary windows
\endlist
@@ -90,13 +90,13 @@
\list
\o \gui{Issues} pane Alt+1 (Cmd+1 on Mac OS X)
\li \gui{Issues} pane Alt+1 (Cmd+1 on Mac OS X)
\o \gui{Search Results} pane Alt+2 (Cmd+2 on Mac OS X)
\li \gui{Search Results} pane Alt+2 (Cmd+2 on Mac OS X)
\o \gui{Application Output} pane Alt+3 (Cmd+3 on Mac OS X)
\li \gui{Application Output} pane Alt+3 (Cmd+3 on Mac OS X)
\o \gui{Compile Output} pane Alt+4 (Cmd+4 on Mac OS X)
\li \gui{Compile Output} pane Alt+4 (Cmd+4 on Mac OS X)
\endlist
@@ -178,10 +178,10 @@
To switch off the debugging helpers:
\list 1
\o Select \gui Tools > \gui Options > \gui Debugger >
\li Select \gui Tools > \gui Options > \gui Debugger >
\gui{Debugging Helper}.
\o Uncheck the \gui{Use Debugging Helper} checkbox.
\li Uncheck the \gui{Use Debugging Helper} checkbox.
\endlist
@@ -192,9 +192,9 @@
\list 1
\o Select \gui Tools > \gui Options > \gui Debugger > \gui General.
\li Select \gui Tools > \gui Options > \gui Debugger > \gui General.
\o Select the \gui {Use tooltips in main editor while debugging} check
\li Select the \gui {Use tooltips in main editor while debugging} check
box.
\endlist
@@ -230,14 +230,14 @@
\list 1
\o \c %YEAR%: Year
\o \c %MONTH%: Month
\o \c %DAY%: Day of the month
\o \c %DATE%: Date
\o \c %USER%: User name
\o \c %FILENAME%: File name
\o \c %CLASS%: Class name (if applicable)
\o \c %$VARIABLE%: Contents of environment variable \c{VARIABLE}.
\li \c %YEAR%: Year
\li \c %MONTH%: Month
\li \c %DAY%: Day of the month
\li \c %DATE%: Date
\li \c %USER%: User name
\li \c %FILENAME%: File name
\li \c %CLASS%: Class name (if applicable)
\li \c %$VARIABLE%: Contents of environment variable \c{VARIABLE}.
\endlist

96
doc/src/howto/creator-ui.qdoc
View File

@@ -34,15 +34,15 @@
\list
\o Open recent sessions and projects
\li Open recent sessions and projects
\o Create and open projects
\li Create and open projects
\o Open tutorials and example projects
\li Open tutorials and example projects
\o Read news from the online community and Qt labs
\li Read news from the online community and Qt labs
\o Send feedback to the development team
\li Send feedback to the development team
\endlist
@@ -75,26 +75,26 @@
\list
\o \gui Welcome mode for opening projects.
\li \gui Welcome mode for opening projects.
\o \gui{\l{Coding}{Edit}} mode for editing project and source
\li \gui{\l{Coding}{Edit}} mode for editing project and source
files.
\o \gui{\l{Designing User Interfaces}{Design}} mode for designing and
\li \gui{\l{Designing User Interfaces}{Design}} mode for designing and
developing application user interfaces. This mode is available for
UI files.
\o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your
\li \gui{\l{Debugging}{Debug}} mode for inspecting the state of your
application while debugging.
\o \gui{\l{Specifying Build Settings}{Projects}} mode for configuring
\li \gui{\l{Specifying Build Settings}{Projects}} mode for configuring
project building and execution. This mode is available when a
project is open.
\o \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
\li \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
to detect memory leaks and profile C++ or QML code.
\o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\li \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\endlist
@@ -114,23 +114,23 @@
\list
\o \gui Projects shows a list of projects open in the current
\li \gui Projects shows a list of projects open in the current
session.
\o \gui{Open Documents} shows currently open files.
\li \gui{Open Documents} shows currently open files.
\o \gui Bookmarks shows all bookmarks for the current session.
\li \gui Bookmarks shows all bookmarks for the current session.
\o \gui{File System} shows all files in the currently selected
\li \gui{File System} shows all files in the currently selected
directory.
\o \gui {Class View} shows the class hierarchy of the currently
\li \gui {Class View} shows the class hierarchy of the currently
open projects.
\o \gui Outline shows the symbol hierachy of a C++ file and the element
\li \gui Outline shows the symbol hierarchy of a C++ file and the element
hierarchy of a QML file.
\o \gui {Type Hierarchy} shows the base classes of a class.
\li \gui {Type Hierarchy} shows the base classes of a class.
\endlist
@@ -138,14 +138,14 @@
\list
\o To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
\li To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
(\gui {Hide Sidebar/Show Sidebar}) or press \key Alt+0
(\key Cmd+0 on Mac OS X).
\o To split the sidebar, click \inlineimage qtcreator-splitbar.png
\li To split the sidebar, click \inlineimage qtcreator-splitbar.png
(\gui {Split}). Select new content to view in the split view.
\o To close a sidebar view, click
\li To close a sidebar view, click
\inlineimage qtcreator-closesidebar.png
(\gui {Close}).
@@ -165,29 +165,29 @@
\list
\o To open files that belong to a project, double-click them in the
\li To open files that belong to a project, double-click them in the
project tree. Files open in the appropriate editor, according to the
file type. For example, code source files open in the code editor
and image files in the \l{Viewing Images}{image viewer}.
\o To bring up a context menu containing the actions most commonly
\li To bring up a context menu containing the actions most commonly
needed right-click an item in the project tree. For example, through
the menu of the project root directory you can, among other actions,
build, re-build, clean and run the project.
\o To hide the categories and sort project files alphabetically, click
\li To hide the categories and sort project files alphabetically, click
\inlineimage qtcreator-filter.png
(\gui {Filter Tree}) and select \gui{Simplify Tree}.
\o To hide source files which are automatically generated by the build
\li To hide source files which are automatically generated by the build
system, select \gui {Filter Tree > Hide Generated Files}.
\o To keep the position in the project tree synchronized with the file
\li To keep the position in the project tree synchronized with the file
currently opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
(\gui {Synchronize with Editor}).
\o To see the absolute path of a file, move the mouse pointer over the
\li To see the absolute path of a file, move the mouse pointer over the
file name.
\endlist
@@ -213,10 +213,10 @@
\list
\o To see a complete list of all bindings, select \gui {Filter Tree >
\li To see a complete list of all bindings, select \gui {Filter Tree >
Show All Bindings}.
\o To keep the position in the view synchronized with the element
\li To keep the position in the view synchronized with the element
selected in the editor, select \gui {Synchronize with Editor}.
\endlist
@@ -232,19 +232,19 @@
\list
\o \gui{Issues}
\li \gui{Issues}
\o \gui{Search Results}
\li \gui{Search Results}
\o \gui{Application Output}
\li \gui{Application Output}
\o \gui{Compile Output}
\li \gui{Compile Output}
\o \gui {To-Do Entries}
\li \gui {To-Do Entries}
\o \gui{Version Control}
\li \gui{Version Control}
\o \gui{General Messages}
\li \gui{General Messages}
\endlist
@@ -268,22 +268,22 @@
\list
\o \gui Analyzer - Errors encountered while running the
\li \gui Analyzer - Errors encountered while running the
\l{Analyzing Code}{Valgrind code analysis tools}.
\o \gui {Build System} - Errors and warnings encountered during a
\li \gui {Build System} - Errors and warnings encountered during a
build.
\o \gui Compile - Selected output from the compiler. Open the
\li \gui Compile - Selected output from the compiler. Open the
\gui {Compile Output} pane for more detailed information.
\o \gui {My Tasks} - Entries from a task list file (.tasks) generated
\li \gui {My Tasks} - Entries from a task list file (.tasks) generated
by \l{Showing Task List Files in Issues Pane}
{code scanning and analysis tools}.
\o \gui QML - Errors in QML syntax.
\li \gui QML - Errors in QML syntax.
\o \gui {QML Analysis} - Results of the JavaScript
\li \gui {QML Analysis} - Results of the JavaScript
\l{Checking JavaScript and QML Syntax}
{code syntax and validation checks}
@@ -382,15 +382,15 @@
\list
\o Switch between background and outline modes
\li Switch between background and outline modes
\o Zoom in and out
\li Zoom in and out
\o Fit images to screen
\li Fit images to screen
\o Return to original size
\li Return to original size
\o Play and pause animated GIF and MNG images
\li Play and pause animated GIF and MNG images
\endlist

278
doc/src/howto/creator-vcs.qdoc
View File

@@ -33,37 +33,37 @@
Version control systems supported by \QC are:
\table
\header
\o Version Control System
\o Address
\o Notes
\li Version Control System
\li Address
\li Notes
\row
\o Bazaar
\o \l{http://bazaar.canonical.com/}
\o \QC 2.2 and later
\li Bazaar
\li \l{http://bazaar.canonical.com/}
\li \QC 2.2 and later
\row
\o ClearCase
\o \l{http://www-01.ibm.com/software/awdtools/clearcase/}
\i Experimental plugin in \QC 2.6
\li ClearCase
\li \l{http://www-01.ibm.com/software/awdtools/clearcase/}
\li Experimental plugin in \QC 2.6
\row
\o CVS
\o \l{http://www.cvshome.org}
\i
\li CVS
\li \l{http://www.cvshome.org}
\li
\row
\o Git
\o \l{http://git-scm.com/}
\i
\li Git
\li \l{http://git-scm.com/}
\li
\row
\o Mercurial
\o \l{http://mercurial.selenic.com/}
\o \QC 2.0 and later
\li Mercurial
\li \l{http://mercurial.selenic.com/}
\li \QC 2.0 and later
\row
\o Perforce
\o \l{http://www.perforce.com}
\o Server version 2006.1 and later
\li Perforce
\li \l{http://www.perforce.com}
\li Server version 2006.1 and later
\row
\o Subversion
\o \l{http://subversion.apache.org/}
\i
\li Subversion
\li \l{http://subversion.apache.org/}
\li
\endtable
\section1 Setting Up Version Control Systems
@@ -101,13 +101,13 @@
\list
\o \gui{Submit message check script} is a script or program that
\li \gui{Submit message check script} is a script or program that
can be used to perform checks on the submit message before
submitting. The submit message is passed in as the script's first
parameter. If there is an error, the script should output a
message on standard error and return a non-zero exit code.
\o \gui{User/alias configuration file} takes a file in mailmap format
\li \gui{User/alias configuration file} takes a file in mailmap format
that lists user names and aliases. For example:
\code
@@ -121,7 +121,7 @@
displays a context menu with \gui{Insert name} that pops up a
dialog letting the user select a name.
\o \gui{User fields configuration file} is a simple text file
\li \gui{User fields configuration file} is a simple text file
consisting of lines specifying submit message fields that take
user names, for example:
@@ -135,7 +135,7 @@
\e{User/alias configuration file} as well as a button that opens the
aforementioned user name dialog.
\o \gui{SSH prompt command} specifies an ssh-askpass command that you
\li \gui{SSH prompt command} specifies an ssh-askpass command that you
can use (on Linux) to prompt the user for a password when using SSH.
For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the
ssh-askpass implementation that you use.
@@ -255,14 +255,14 @@
\list
\o \gui{Undo Unstaged Changes} reverts all changes and resets the
\li \gui{Undo Unstaged Changes} reverts all changes and resets the
working directory to the state of the index.
\o \gui{Undo Uncommitted Changes} reverts all changes, discarding the
\li \gui{Undo Uncommitted Changes} reverts all changes, discarding the
index. This returns your working copy to the state it was in right
after the last commit.
\o \gui{Reset...} opens a dialog where you can select the SHA1 to reset
\li \gui{Reset...} opens a dialog where you can select the SHA1 to reset
the working directory to. This is useful after applying patches for
review, for example.
@@ -297,14 +297,14 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Pull}
\o Turn the branch into a mirror of another branch.
\li \gui{Pull}
\li Turn the branch into a mirror of another branch.
\row
\o \gui{Push}
\o Update a mirror of the branch.
\li \gui{Push}
\li Update a mirror of the branch.
\endtable
@@ -321,27 +321,27 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Check In}
\o Create a permanent new version of the current file or all files
\li \gui{Check In}
\li Create a permanent new version of the current file or all files
in the versioned object base (VOB).
\row
\o \gui{Check In Activity}
\o Check in checked-out versions in the change set of the current
\li \gui{Check In Activity}
\li Check in checked-out versions in the change set of the current
Unified Change Management (UCM) activity.
\row
\o \gui{Check Out}
\o Create a writable copy of a branch. If you check out files in a
\li \gui{Check Out}
\li Create a writable copy of a branch. If you check out files in a
UCM view, they are added to the change set of the UCM activity.
\row
\o \gui{Undo Check Out}
\o Cancel the checkout for a file and delete the checked-out
\li \gui{Undo Check Out}
\li Cancel the checkout for a file and delete the checked-out
version.
\row
\o \gui{Undo Hijack}
\o Resolve hijacked files. If you change the read-only attribute of
\li \gui{Undo Hijack}
\li Resolve hijacked files. If you change the read-only attribute of
a file that is loaded into a snapshot view and modify the file
without checking it out, you \e hijack the file.
\endtable
@@ -354,14 +354,14 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Edit}
\o Open a file for editing.
\li \gui{Edit}
\li Open a file for editing.
\row
\o \gui{Unedit}
\o Discard the changes that you made in a file.
\li \gui{Unedit}
\li Discard the changes that you made in a file.
\endtable
@@ -378,53 +378,53 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui {Patch > Apply from Editor/Apply from File}
\o Patches are rewriting instructions that can be applied to a set
\li \gui {Patch > Apply from Editor/Apply from File}
\li Patches are rewriting instructions that can be applied to a set
of files. You can either apply a patch file that is open in \QC
or select the patch file to apply from the file system.
\row
\o \gui{Pull}
\o Pull changes from the remote repository. If there are locally
\li \gui{Pull}
\li Pull changes from the remote repository. If there are locally
modified files, you are prompted to stash those changes. Select
\gui{Tools > Options > Version Control > Git} and select the
\gui {Pull with rebase} check box to perform a rebase operation
while pulling.
\row
\o \gui{Clean/Clean Project}
\o All files that are not under version control (with the exception
\li \gui{Clean/Clean Project}
\li All files that are not under version control (with the exception
of patches and project files) are displayed in the \gui {Clean
Repository} dialog. Select the files to delete and click
\gui Delete. This allows you to clean a build completely.
\row
\o \gui{Launch gitk}
\o Start the commit viewer for Git, gitk.
\li \gui{Launch gitk}
\li Start the commit viewer for Git, gitk.
\row
\o \gui{Branches}
\o Manage local and remote branches.
\li \gui{Branches}
\li Manage local and remote branches.
\row
\o \gui Remotes
\o Manage remote repositories available in Git.
\li \gui Remotes
\li Manage remote repositories available in Git.
\row
\o \gui {Stage File for Commit}
\o Mark new or modified files for committing to the repository.
\li \gui {Stage File for Commit}
\li Mark new or modified files for committing to the repository.
To undo this function, select \gui {Unstage File from Commit}.
\row
\o \gui{Show Commit}
\o Select a commit to view. Enter the SHA of the commit
\li \gui{Show Commit}
\li Select a commit to view. Enter the SHA of the commit
in the \gui Change field.
\row
\o \gui Stash
\o Store local changes temporarily.
\li \gui Stash
\li Store local changes temporarily.
\row
\o \gui{Amend Last Commit}
\o Revert the last commit.
\li \gui{Amend Last Commit}
\li Revert the last commit.
\row
\o \gui Gerrit
\o View, apply, and check out changes from Gerrit.
\li \gui Gerrit
\li View, apply, and check out changes from Gerrit.
\endtable
@@ -440,27 +440,27 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Add}
\o Create new tracking and non-tracking branches.
\li \gui{Add}
\li Create new tracking and non-tracking branches.
\row
\o \gui{Checkout}
\o Check out the selected branch and make it current.
\li \gui{Checkout}
\li Check out the selected branch and make it current.
\row
\o \gui{Remove}
\o Remove a local branch. You cannot delete remote branches.
\li \gui{Remove}
\li Remove a local branch. You cannot delete remote branches.
\row
\o \gui{Diff}
\o Show the differences between the selected and the current
\li \gui{Diff}
\li Show the differences between the selected and the current
branch.
\row
\o \gui{Log}
\o Show the changes in a branch.
\li \gui{Log}
\li Show the changes in a branch.
\row
\o \gui{Refresh}
\o Refresh the list of branches.
\li \gui{Refresh}
\li Refresh the list of branches.
\endtable
\section3 Working with Remote Repositories
@@ -472,21 +472,21 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Add}
\o Add a new remote repository.
\li \gui{Add}
\li Add a new remote repository.
\row
\o \gui{Fetch}
\o Fetch all the branches and change information from a remote
\li \gui{Fetch}
\li Fetch all the branches and change information from a remote
repository.
\row
\o \gui{Remove}
\o Remove a remote repository.
\li \gui{Remove}
\li Remove a remote repository.
\row
\o \gui{Refresh}
\o Refresh the list of remote repositories.
\li \gui{Refresh}
\li Refresh the list of remote repositories.
\endtable
@@ -501,27 +501,27 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Stashes}
\o Display a dialog that shows all known stashes with options to
\li \gui{Stashes}
\li Display a dialog that shows all known stashes with options to
restore, display or delete them.
\row
\o \gui{Stash}
\o Stash all local changes. The working copy is then reset to
\li \gui{Stash}
\li Stash all local changes. The working copy is then reset to
the state it had right after the last commit.
\row
\o \gui{Stash Snapshot}
\o Save a snapshot of your current work under a name for later
\li \gui{Stash Snapshot}
\li Save a snapshot of your current work under a name for later
reference. The working copy is unchanged.
For example, if you want to try something and find out later
that it does not work, you can discard it and return to the
state of the snapshot.
\row
\o \gui{Stash Pop}
\o Remove a single stashed state from the stash list and apply it
\li \gui{Stash Pop}
\li Remove a single stashed state from the stash list and apply it
on top of the current working tree state.
\endtable
@@ -559,25 +559,25 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Import}
\o Apply changes from a patch file.
\li \gui{Import}
\li Apply changes from a patch file.
\row
\o \gui{Incoming}
\o Monitor the status of a remote repository by listing
\li \gui{Incoming}
\li Monitor the status of a remote repository by listing
the changes that will be pulled.
\row
\o \gui{Outgoing}
\o Monitor the status of a remote repository by listing
\li \gui{Outgoing}
\li Monitor the status of a remote repository by listing
the changes that will be pushed.
\row
\o \gui{Pull}
\o Pull changes from the remote repository.
\li \gui{Pull}
\li Pull changes from the remote repository.
\row
\o \gui{Push}
\o Push changes to the remote repository.
\li \gui{Push}
\li Push changes to the remote repository.
\endtable
\section2 Using Additional Perforce Functions
@@ -603,20 +603,20 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Describe}
\o View information about changelists and the files in them.
\li \gui{Describe}
\li View information about changelists and the files in them.
\row
\o \gui{Edit File}
\o Open a file for editing.
\li \gui{Edit File}
\li Open a file for editing.
\row
\o \gui{Opened}
\o List files that are open for editing.
\li \gui{Opened}
\li List files that are open for editing.
\row
\o \gui{Pending Changes}
\o Group files for commit.
\li \gui{Pending Changes}
\li Group files for commit.
\endtable
\section2 Using Additional Subversion Functions
@@ -627,11 +627,11 @@
\table
\header
\o Menu Item
\o Description
\li Menu Item
\li Description
\row
\o \gui{Describe}
\o Display commit log messages for a revision.
\li \gui{Describe}
\li Display commit log messages for a revision.
\endtable
*/

66
doc/src/howto/qtcreator-faq.qdoc
View File

@@ -32,29 +32,29 @@
\section1 General Questions
\bold {How do I reset all \QC settings?}
\b {How do I reset all \QC settings?}
\QC creates the following files and directories:
\list
\o QtCreator.db
\li QtCreator.db
\o QtCreator.ini
\li QtCreator.ini
\o qtversion.xml
\li qtversion.xml
\o toolChains.xml
\li toolChains.xml
\o qtcreator
\li qtcreator
\o qtc-debugging-helper
\li qtc-debugging-helper
\o qtc-qmldbg
\li qtc-qmldbg
\o qtc-qmldump
\li qtc-qmldump
\o qtc-qmlobserver
\li qtc-qmlobserver
\endlist
@@ -72,11 +72,11 @@
\c {<drive>:\Users\<username>\AppData\Roaming\QtProject} and
\c {<drive>:\Users\<username>\AppData\Local\QtProject}.
\bold {\QC comes with MinGW, should I use this version with Qt?}
\b {\QC comes with MinGW, should I use this version with Qt?}
Use the version that was built against the Qt version.
\bold {\QC does not find a helper application, such as Git or a
\b {\QC does not find a helper application, such as Git or a
compiler. What should I do?}
Make sure that the application is in your system PATH when starting \QC.
@@ -87,7 +87,7 @@
This is especially relevant for the Mac OS where \c {/usr/local/bin} might
not be in the path when \QC is started.
\bold {How do I change the interface language for \QC?}
\b {How do I change the interface language for \QC?}
\QC has been localized into several languages. If the system
language is one of the supported languages, it is automatically selected.
@@ -95,18 +95,18 @@
select a language in the \gui Language field. The change takes effect after
you restart \QC.
\bold {Has a reported issue been addressed?}
\b {Has a reported issue been addressed?}
You can look up any issue in the
\l{https://bugreports.qt-project.org/}{Qt bug tracker}.
\if defined(qcmanual)
\input widgets/creator-faq-qtdesigner.qdocinc
\include widgets/creator-faq-qtdesigner.qdocinc
\endif
\section1 Help Questions
\bold {The Qt API Reference Documentation is missing and context help does
\b {The Qt API Reference Documentation is missing and context help does
not find topics. What can I do?}
\QC comes fully integrated with Qt documentation and examples using
@@ -124,7 +124,7 @@
For information on troubleshooting debugger, see
\l{Troubleshooting Debugger}.
\bold {If I have a choice of GDB versions, which should I use?}
\b {If I have a choice of GDB versions, which should I use?}
On Linux and Windows, use the Python-enabled GDB versions that are
installed when you install \QC and Qt SDK. On Mac OS X, use the GDB
@@ -136,7 +136,7 @@
For more information on setting up debugger, see \l{Setting Up Debugger}.
\bold {How do I generate a core file in \QC?}
\b {How do I generate a core file in \QC?}
To trigger the GDB command that generates a core file while debugging,
select \gui {Window > Views > Debugger Log}. In the \gui Command field,
@@ -150,7 +150,7 @@
\section1 Compiler Questions
\bold {How can I make use of my multi-core CPU with \QC?}
\b {How can I make use of my multi-core CPU with \QC?}
On Linux and Mac OS X, go to \gui Project mode, select your configuration
in the \gui {Build Settings}, locate the \gui {Build Steps}, and add the
@@ -169,13 +169,13 @@
\section1 Qt SDK Questions
\bold {I cannot use QSslSocket with the SDK. What should I do?}
\b {I cannot use QSslSocket with the SDK. What should I do?}
The Qt build in the SDK is built with QT_NO_OPENSSL defined. Rebuilding it
is possible. For more information, see
\l{http://www.qtcentre.org/threads/19222-Qssl}.
\bold {Which development packages from the distribution are needed on
\b {Which development packages from the distribution are needed on
Ubuntu or Debian?}
\code
@@ -190,16 +190,16 @@
\section1 Platform Related Questions
\bold {Where is application output shown in \QC?}
\b {Where is application output shown in \QC?}
\bold {On Unix (Linux and Mac OS):} \c qDebug() and related functions use
\b {On Unix (Linux and Mac OS):} \c qDebug() and related functions use
the standard output and error output. When you run or debug the
application, you can view the output in the \gui{Application Output} pane.
For console applications that require input, select \gui {Projects > Run
Settings > Run in terminal}.
\bold {On Windows:} Output is displayed differently for \e{console
\b {On Windows:} Output is displayed differently for \e{console
applications} and \e{GUI applications}.
The setting \c {CONFIG += console} in the .pro file specifies that the
@@ -224,30 +224,30 @@
\section1 Questions about New Features
\bold {Will a requested feature be implemented?}
\b {Will a requested feature be implemented?}
If it is a scheduled feature, you can see this in the task tracker. If a
feature already has been implemented, it is mentioned in the
\l{http://qt.gitorious.org/qt-creator/qt-creator/trees/master/dist}{changes file}
for the upcoming release.
\bold {Why does \QC not use tabs for editors?}
\b {Why does \QC not use tabs for editors?}
This question comes up from time to time, so we have considered it
carefully. Here are our main reasons for not using tabs:
\list
\o Tabs do not scale. They work fine if you have 5 to 6 editors open,
\li Tabs do not scale. They work fine if you have 5 to 6 editors open,
they become cumbersome with 10, and if you need more horizontal
space than the tab bar, the interface does not work at all.
\o Tabs do not adapt to your working set.
\li Tabs do not adapt to your working set.
\o The common solution is to give the user the ability to reorder
\li The common solution is to give the user the ability to reorder
tabs. Now user has to manage tabs instead of writing code.
\o Tabs force you to limit the amount of open editors, because
\li Tabs force you to limit the amount of open editors, because
otherwise you get confused.
\endlist
@@ -273,11 +273,11 @@
\list
\o Press \key F4 to switch between header and source.
\li Press \key F4 to switch between header and source.
\o Press \key Alt+Left to move backwards in the navigation history.
\li Press \key Alt+Left to move backwards in the navigation history.
\o Use the locator (Ctrl+K) to simply tell \QC where to go.
\li Use the locator (Ctrl+K) to simply tell \QC where to go.
\endlist