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

Doc: Describe To-Do options

Browse Source 
Update the screenshot and add a new one hat shows the options.

Change-Id: I7ceccef2c7c5bad5be4af58588c378a0df5e1383
Reviewed-by: Niels Weber <niels.weber@qt.io>
This commit is contained in:
Leena Miettinen
2017-05-09 13:50:55 +02:00
parent 9f9776c4c9
commit 939913de5a
3 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/images/qtcreator-todo-options.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
doc/images/qtcreator-todo-pane.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 35 KiB

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

@@ -504,20 +504,32 @@
\section2 To-Do Entries \section2 To-Do Entries
The \uicontrol {To-Do Entries} pane lists the BUG, FIXME, NOTE, TODO, and The \uicontrol {To-Do Entries} pane lists the BUG, FIXME, NOTE, TODO, and
WARNING keywords from the current file or from all project files. The WARNING keywords from the current file, from all project files, or from a
keywords are organized into information, warning, and error categories. subproject. Click the icons on the toolbar to show only the selected
keywords.
\image qtcreator-todo-pane.png \image qtcreator-todo-pane.png
To add keywords, select \uicontrol Tools > \uicontrol Options > To add keywords, select \uicontrol Tools > \uicontrol Options >
\uicontrol {To-Do} > \uicontrol Add. \uicontrol {To-Do} > \uicontrol Add. Set an icon and a line background color
Set an icon and a line background color for the keyword. To change the icons for the keyword.
and colors set for an existing keyword, select \uicontrol Edit.
To determine whether the keywords in the whole project or in the current \image qtcreator-todo-options.png
file are displayed by default, select \uicontrol {Scanning scope}.
To exclude files from scanning, select \uicontrol {To-Do} in the To change the icon and line background color of the selected keyword, select
\uicontrol Edit.
To remove the selected keyword, select \uicontrol Remove.
To reset the list to predefined keywords, select \uicontrol Reset. All your
changes will be permanently lost.
To determine whether the keywords in the whole project, in the current file,
or in a subproject are displayed by default, select the appropriate option
in the \uicontrol {Scanning scope} group.
To exclude files from scanning, select \uicontrol {Project Settings} >
\uicontrol {To-Do} in the
\uicontrol Projects mode. Select \uicontrol Add and enter a regular \uicontrol Projects mode. Select \uicontrol Add and enter a regular
expression that matches the path to files to exclude. Use a forward slash expression that matches the path to files to exclude. Use a forward slash
(/) as a separator in the path also on Windows. (/) as a separator in the path also on Windows.