diff --git a/doc/images/qtcreator-todo-pane.png b/doc/images/qtcreator-todo-pane.png new file mode 100644 index 00000000000..60878b24260 Binary files /dev/null and b/doc/images/qtcreator-todo-pane.png differ diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index cf5e5fcb42e..5c0cc1f0845 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -243,10 +243,12 @@ \o \gui{Compile Output} - \o \gui{General Messages} + \o \gui {To-Do Entries} \o \gui{Version Control} + \o \gui{General Messages} + \endlist Output panes are available in all \l{Modes}{modes}. Click the name of an @@ -260,7 +262,8 @@ To open the \gui{General Messages} and \l{Using Version Control Systems} {Version Control} panes, select - \gui {Window > Output Panes}. + \gui {Window > Output Panes}. To display the \gui {To-Do Entries} pane, + enable the Todo plugin. \section2 Issues @@ -333,6 +336,29 @@ \image qtcreator-compile-pane.png + \section2 To-Do List + + The \gui {To-Do List Entries} pane lists the BUG, FIXME, NOTE, TODO, and + WARNING keywords from the current file or from all project files. The + keywords are organized into information, warning, and error categories. + + \image qtcreator-todo-pane.png + + To add keywords, select \gui Tools > \gui Options > \gui {To-Do} > \gui Add. + Set an icon and a line background color for the keyword. To change the icons + and colors set for an existing keyword, select \gui Edit. + + To determine whether the keywords in the whole project or in the current + file are displayed by default, select \gui {Scanning scope}. + + The Todo plugin is disabled by default. To enable the plugin, select + \gui Help > \gui {About Plugins} > \gui Utilities > \gui Todo and restart + \QC. + + In addition, you can open task list files generated by code scanning and + analysis tools in the \gui Issues pane. For more information, see + \l{Showing Task List Files in Issues Pane}. + \section1 Changing Languages \QC has been localized into several languages. If the system language is one