
@@ -416,98 +416,6 @@
USER INTERFACE
-
Start Window
-
On every start of Coati you are shown the start window. It allows for creating new projects or opening existing ones.
-
-
-

-
-
-
Interactions:
-
- - Clicking New Project will lead you to Project Setup.
- - Clicking Open Project will let you open an existing Coati project by choosing from a file dialog.
- - Clicking on one of the Recent Projects will open this project. The list shows a maximum of 7 items ordered by recent first.
- - Pressing ESC will close the window.
-
-
-
Path List Box
-
The Path List Box is a user interface element that is used within the Preferences Window and the Project Setup Window. It allows for entering a list of file and directory paths.
-
-
-

-
-
-
Interactions:
-
- - Click the "+" icon to add a new path line.
- - Click the "-" icon to remove a selected path line.
- - Click a path line to select it.
- - Enter the path by typing on your keyboard
- - Click "..." within the path line to open a file dialog for choosing a file or directory path.
- - Directly add multiple paths into the box by dropping elements from your filesystem.
-
-
-
-
Preferences Window
-
The Preferences window lets you define settings for all projects. You can open the Preferences from the menu via Help/Preferences or from the Project Setup Window by pressing the Preferences button.
-
-
-

-
-
-
-
- | Setting | Description |
-
-
- | Header Search Paths | Set header search paths that are used for all of your projects (e.g. std headers). (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations) |
- | Framework Search Paths | Mac only. Define the search paths for .framework files for all of your projects. (For instructions on how to add paths see Path List Box.) |
-
-
-
-
-
Project Setup Window
-
The Project Setup Window lets you create a new Coati project.
-
-
-

-
-
-
Interactions:
-
- - Clicking Cancel will close the window.
- - Clicking Create will check your inputs, save the new project file and start analyzing the source files.
- - Pressing ESC will close the window.
-
-
-
- | Setting | Description |
-
-
- | Name | The name of the project. This will also be the name of the project file. |
- | Location | Choose the location of the project file from the dialog. |
- | Language | Select the language of your project. (See Language Support) |
- | Standard | Select the language standard that should be used for analyzing your project. (See Language Support) |
- | Analyzed Paths | Specify one or multiple locations that contain all the source and header files that should be analyzed by Coati. (For instructions on how to add paths see Path List Box.) |
- | Header Search Paths | Specify where Coati should be looking for included headers. (For instructions on how to add paths see Path List Box.) |
- | Framework Search Paths | Mac only. Define the search paths for .framework files for your project. (For instructions on how to add paths see Path List Box.) |
-
-
-
-
Enter License Window
-
The Enter License Window appears on your first start of Coati and is used to enter and check your Coati license key.
-
-
-

-
-
-
Interactions:
-
- - Copy and Paste your license key from your "Coati 0 License Key" e-mail into the textfield. The key should be formated as shown by the placeholder text.
- - Clicking Activate will check if your license key is valid and close the window. Otherwise an error message will be displayed.
-
-
Main Window
Widget Windows
@@ -539,10 +447,105 @@
+
Other Windows
+
Start Window
+
On every start of Coati you are shown the start window. It allows for creating new projects or opening existing ones.
+
+
+

+
+
+
Interactions:
+
+ - Clicking New Project will lead you to Project Setup.
+ - Clicking Open Project will let you open an existing Coati project by choosing from a file dialog.
+ - Clicking on one of the Recent Projects will open this project. The list shows a maximum of 7 items ordered by recent first.
+ - Pressing ESC will close the window.
+
-
Menu Structure
+
Path List Box
+
The Path List Box is a user interface element that is used within the Preferences Window and the Project Setup Window. It allows for entering a list of file and directory paths.
+
+
+

+
+
+
Interactions:
+
+ - Click the "+" icon to add a new path line.
+ - Click the "-" icon to remove a selected path line.
+ - Click a path line to select it.
+ - Enter the path by typing on your keyboard
+ - Click "..." within the path line to open a file dialog for choosing a file or directory path.
+ - Directly add multiple paths into the box by dropping elements from your filesystem.
+
-
Project
+
+
Preferences Window
+
The Preferences window lets you define settings for all projects. You can open the Preferences from the menu via Help/Preferences or from the Project Setup Window by pressing the Preferences button.
+
+
+

+
+
+
+
+ | Setting | Description |
+
+
+ | Header Search Paths | Set header search paths that are used for all of your projects (e.g. std headers). (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations) |
+ | Framework Search Paths | Mac only. Define the search paths for .framework files for all of your projects. (For instructions on how to add paths see Path List Box.) |
+
+
+
+
+
Project Setup Window
+
The Project Setup Window lets you create a new Coati project.
+
+
+

+
+
+
Interactions:
+
+ - Clicking Cancel will close the window.
+ - Clicking Create will check your inputs, save the new project file and start analyzing the source files.
+ - Pressing ESC will close the window.
+
+
+
+ | Setting | Description |
+
+
+ | Name | The name of the project. This will also be the name of the project file. |
+ | Location | Choose the location of the project file from the dialog. |
+ | Language | Select the language of your project. (See Language Support) |
+ | Standard | Select the language standard that should be used for analyzing your project. (See Language Support) |
+ | Analyzed Paths | Specify one or multiple locations that contain all the source and header files that should be analyzed by Coati. (For instructions on how to add paths see Path List Box.) |
+ | Header Search Paths | Specify where Coati should be looking for included headers. (For instructions on how to add paths see Path List Box.) |
+ | Framework Search Paths | Mac only. Define the search paths for .framework files for your project. (For instructions on how to add paths see Path List Box.) |
+
+
+
+
Enter License Window
+
The Enter License Window appears on your first start of Coati and is used to enter and check your Coati license key.
+
+
+

+
+
+
Interactions:
+
+ - Copy and Paste your license key from your "Coati 0 License Key" e-mail into the textfield. The key should be formated as shown by the placeholder text.
+ - Clicking Activate will check if your license key is valid and close the window. Otherwise an error message will be displayed.
+
+
+
+
Menu
+
+
Structure
+
+
Project
-
New Project
@@ -592,7 +595,7 @@
-
Edit
+
Edit
-
View
+
View
-
Show Title Bars
@@ -686,7 +689,7 @@
-
Help
+
Help
-
About
@@ -716,7 +719,7 @@
-
Shortcuts
+
Shortcuts
| Shortcut | Windows | Mac OS X | Linux |
@@ -1004,6 +1007,18 @@
Pressing enter will select the search result and send the search request.
+ Keywords
+ Additionally the search view provides specific keywords that select a certein group of symbols.
+
+
+ | keyword | effect |
+
+
+ | overview | Shows an overview of all analysed symbols in the graph view and some statistics in the code view. |
+ | error | Shows all errors in the code view. |
+
+
+