Difference between revisions of "IDE Window: ToDo List"
From Free Pascal wiki
Jump to navigationJump to search (Fix intro grammar; update descriptions) |
|||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{IDE Window: ToDo List}} | {{IDE Window: ToDo List}} | ||
| − | The | + | The ToDo list shows the list of ToDo comments in all project units. |
| − | + | Until 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: | Make comments in source-code like these: | ||
| − | <syntaxhighlight> | + | <syntaxhighlight lang=pascal> |
{TODO -oOwnerName -cCategoryName: Todo_text} | {TODO -oOwnerName -cCategoryName: Todo_text} | ||
{DONE -oOwnerName -cCategoryName: Todo_text} | {DONE -oOwnerName -cCategoryName: Todo_text} | ||
{#todo -oOwnerName -cCategoryName: Todo_text} | {#todo -oOwnerName -cCategoryName: Todo_text} | ||
{#done -oOwnerName -cCategoryName: Todo_text} | {#done -oOwnerName -cCategoryName: Todo_text} | ||
| + | { ToDo: Todo_text} | ||
| + | // ToDo: Todo_text | ||
| + | (* ToDo: Todo_text *) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
The -o and -c tags are optional. | The -o and -c tags are optional. | ||
| + | |||
| + | == Controls == | ||
Buttons: | Buttons: | ||
| − | * Refresh: Search again all files for ToDo comments and update the list. | + | |
| − | * Goto: Jump to the item in the source editor. | + | * '''Refresh''': Search again all files for ToDo comments and update the list. |
| − | * Export: Make report of todo items in a CSV file. | + | * '''Goto''': Jump to the item in the source editor. |
| + | * '''Export''': Make report of todo items in a CSV file. | ||
| + | * '''Help''': Show this help page. | ||
| + | |||
| + | Options: | ||
| + | |||
| + | * '''Listed''': Search units listed ion project inspector / package editor. | ||
| + | * '''Used''': Search units used by main source file. | ||
| + | * '''Editor''': Search units in the source editor. | ||
| + | * '''Packages''': Search units from used packages. | ||
Listbox: | Listbox: | ||
| − | * | + | * Click the ToDo item in the list to jump to the ToDo item in the source editor. |
| − | |||
| − | |||
Latest revision as of 12:06, 27 March 2021
│
Deutsch (de) │
English (en) │
suomi (fi) │
français (fr) │
The ToDo list shows the list of ToDo comments in all project units.
Until 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.
- Help: Show this help page.
Options:
- Listed: Search units listed ion project inspector / package editor.
- Used: Search units used by main source file.
- Editor: Search units in the source editor.
- Packages: Search units from used packages.
Listbox:
- Click the ToDo item in the list to jump to the ToDo item in the source editor.
