Difference between revisions of "IDE Window: ToDo List"

From Free Pascal wiki
Jump to navigationJump to search
m (Fixed syntax highlighting)
(16 intermediate revisions by 6 users not shown)
Line 1: Line 1:
The todo list shows the list of ToDo comments of all fiels in the source editor.
+
{{IDE Window: ToDo List}}
  
= Refresh =
+
The todo list shows the list of ToDo comments of all project units.
  
Search again all editor files for ToDo comments and update the list.
+
Til Lazarus 1.6 it only searched the units listed in the project inspector. Since 1.7 it searches all used units (i.e. lpr uses section) too.
  
= Goto =
+
Make comments in source-code like these:
  
Jump to the item in the source editor.
+
<syntaxhighlight lang=pascal>
 +
{TODO -oOwnerName -cCategoryName: Todo_text}
 +
{DONE -oOwnerName -cCategoryName: Todo_text}
 +
{#todo -oOwnerName -cCategoryName: Todo_text}
 +
{#done -oOwnerName -cCategoryName: Todo_text}
 +
{ ToDo: Todo_text}
 +
// ToDo: Todo_text
 +
(* ToDo: Todo_text *)
 +
</syntaxhighlight>
  
= List =
+
The -o and -c tags are optional.
  
Double click to jump to the item in the source editor.
+
= Controls =
 +
 
 +
Buttons:
 +
* Refresh: Search again all files for ToDo comments and update the list.
 +
* Goto: Jump to the item in the source editor.
 +
* Export: Make report of todo items in a CSV file.
 +
* Add source editor units: When enabled, scan the units in the source editor as well.
 +
 
 +
Listbox:
 +
 
 +
* Double click to jump to the item in the source editor.

Revision as of 10:47, 17 February 2020

Deutsch (de) English (en) suomi (fi) français (fr)

The todo list shows the list of ToDo comments of all project units.

Til Lazarus 1.6 it only searched the units listed in the project inspector. Since 1.7 it searches all used units (i.e. lpr uses section) too.

Make comments in source-code like these:

{TODO -oOwnerName -cCategoryName: Todo_text}
{DONE -oOwnerName -cCategoryName: Todo_text}
{#todo -oOwnerName -cCategoryName: Todo_text}
{#done -oOwnerName -cCategoryName: Todo_text}
{ ToDo: Todo_text}
// ToDo: Todo_text
(* ToDo: Todo_text *)

The -o and -c tags are optional.

Controls

Buttons:

  • Refresh: Search again all files for ToDo comments and update the list.
  • Goto: Jump to the item in the source editor.
  • Export: Make report of todo items in a CSV file.
  • Add source editor units: When enabled, scan the units in the source editor as well.

Listbox:

  • Double click to jump to the item in the source editor.