Skip to content

GitLab

Commit 582efa43 authored by Rohan Shetty's avatar Rohan Shetty Committed by Oswald Buddenhagen
Browse files
Options

Editing the Quick Tour section as per comments and typo correction.

parent fd577353
Hide whitespace changes
Inline Side-by-side
Showing with 47 additions and 44 deletions
doc/qtcreator.qdoc
View file @ 582efa43
......@@ -288,8 +288,8 @@
\o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\endlist
Certain actions in Qt Creator trigger a mode change. For example,
\gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
Certain actions in Qt Creator trigger a mode change. Clicking on
\gui {Debug} > \gui {Start debugging} > \gui {Start debugging}
automatically switches to \gui {Debug} mode.
......@@ -322,23 +322,22 @@
\section2 Viewing Project Files
When the sidebar shows projects, they are displayed in a project tree. The
project tree contains a list of all projects open in the current session.
The files for each project are grouped according to their file type.
The sidebar displays projects in a project tree. The project tree contains
a list of all projects open in the current session. The files for each
project are grouped according to their file type.
You can use the project tree in the following ways:
\list
\o Double-click a file to open it in an editor.
\o Right-click an item in the project tree to bring up a
context menu containing the actions most commonly needed.
\o 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,
build, re-build, clean and run the project.
among other actions, build, re-build, clean and run the project.
\o To list all files in a project, click
\inlineimage qtcreator-filter.png
and select \gui{Simplify Tree}.
\o During a build, the build system automatically generates source
files. To hide these files, click \inlineimage qtcreator-filter.png
and select \gui{Hide Generated Files}.
and select \gui{Simplify tree}.
\o To hide source files which are automatically generated by the build
system, during a build, click \inlineimage qtcreator-filter.png
and select \gui{Hide generated files}.
\o To toggle the synchronization of your project tree with the file
opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
......@@ -351,15 +350,20 @@
\section1 Viewing Output
The task pane in Qt Creator can display one of the following panes:
\gui{Build Issues}, \gui{Search Results}, \gui{Application Output}, and
\gui{Compile Output}. Output panes are available in all
\l{Qt Creator Modes}{modes}.
\list
\o \gui{Build Issues}
\o \gui{Search Results}
\o \gui{Application Output}
\o \gui{Compile Output}
\endlist
Output panes are available in all \l{Qt Creator modes}{modes}.
\section2 Build Issues
The \gui{Build Issues} pane provides a list of errors and warnings
encoutered during a build. The pane filters out irrelevant output from
encountered during a build. The pane filters out irrelevant output from
the build tools and presents the issues in an organized way.
\image qtcreator-build-issues.png
......@@ -367,9 +371,11 @@
\section2 Search Results
The \gui{Search Results} pane displays the results for global searches
such as searching within a current document, files on disk, or all
projects. The figure below shows an example output of search result for all
The \gui{Search Results} pane displays the results for global searches,
for example, searching within a current document, files on disk, or all
projects.
The figure below shows an example search result for all
occurrences of \c textfinder within the \c "/TextFinder" directory.
\image qtcreator-search-pane.png
......@@ -378,47 +384,44 @@
\section2 Application Output
The \gui{Application Output} pane displays the status of a program when
it is executed, and the debug output. The figure below shows an example
output from qDebug().
it is executed, and the debug output.
The figure below shows an example output from qDebug().
\image qtcreator-application-output.png
\section2 Compile Output
The \gui{Compile Output} pane provides all output from the compiler. In
other words, it is a more detailed version of information displayed in the
\gui{Build Issues} pane.
The \gui{Compile Output} pane provides all output from the compiler.
The \gui{Compile Output} is a more detailed version of information
displayed in the \gui{Build Issues} pane.
\image qtcreator-compile-pane.png
\section1 Getting Help
Qt Creator comes fully integrated with Qt documentation and
examples using the Qt Help plugin. You can get help in the following
ways:
Qt Creator comes fully integrated with all of Qt's documentation and
examples using the Qt Help plugin.
\list
\o To view documentation, switch to \gui Help mode.
\o To obtain context sensitive help, move the text cursor to a Qt class
or function and 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 view documentation, switch to \gui Help mode.
\o To get context sensitive help, move the text cursor to a Qt class or
function and 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.
\image qtcreator-context-sensitive-help.png
\o To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options... > \gui Help.
\endlist
\image qtcreator-context-sensitive-help.png
To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options > \gui Help.
\section2 Adding External Documentation
You can display external documentation in the Qt Creator \gui Help mode.
To augument or replace the documentation that ships with Qt Creator and Qt:
You can display external documentation in Qt Creator's \gui Help mode.
Augment or replace the documentation that ships with Qt Creator and Qt by
performing the following steps:
\list 1
\o Create a .qch file from your documentation.
......@@ -426,7 +429,7 @@
.qch file, see
\l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
\o Add the .qch file to Qt Creator by selecting \gui Tools >
\gui Options > \gui Help > \gui Documentation > \gui Add.
\gui Options... > \gui Help > \gui Documentation > \gui Add.
\endlist
......@@ -3287,7 +3290,7 @@
\o Select \gui{Download} > \gui{Development} > \gui{mad-developer}.
The screenshots below shows the procees of selecting the
The screenshots below shows the process for selecting the
\gui{mad-developer}:
\image qt-creator-app_manager_screenshot1.png
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment