|
| 1 | +## The CodeBrowser makes browsing through projects with multiple files and lots of functions easy, convenient and pleasant. |
| 2 | + |
| 3 | +#### Requirements |
| 4 | + |
| 5 | +- Igor Pro version 6.3.0 or later |
| 6 | + |
| 7 | +#### Installation |
| 8 | + |
| 9 | +1. Install Igor |
| 10 | +2. Start Igor, this will create a folder called WaveMetrics in Documents and then close it |
| 11 | +3. Extract the zip file into folder somewhere on your disc |
| 12 | +4. Create a link from `CodeBrowser-v*/procedures` to `Documents\WaveMetrics\Igor Pro * User Files\Igor Procedures` |
| 13 | +5. Start Igor and in the main menu you can now find `CodeBrowser/Open` |
| 14 | + |
| 15 | +#### Features |
| 16 | + |
| 17 | +- Shows all functions/macros from a procedure file including parameter |
| 18 | + types, return types and special properties (like static, |
| 19 | + threadsafe, etc.) |
| 20 | +- Shows Menu/Constant/StrConstant/Structure entries |
| 21 | +- Shows the structure name for window hook and background tasks for easier searching |
| 22 | +- Allows jumping to their definitions by mouse and keyboard |
| 23 | +- Optionally alphabetically sorted lists |
| 24 | +- Shows function comments as tooltip (IP8 only) |
| 25 | +- Works with Independent Modules |
| 26 | + |
| 27 | +For reasons of ease-of-use the function declarations are displayed as |
| 28 | +`myFunction(var, str) -> var` for a function taking a variable and |
| 29 | +string parameter and returning a variable. Programmers might recognize |
| 30 | +this as being inspired by the trailing return types from C++11. |
| 31 | + |
| 32 | +#### Navigation by keyboard |
| 33 | + |
| 34 | +- Open the panel or brings it to the front with CTRL+0 (zero) |
| 35 | +- Jump to the definition of the listbox selection with "." (dot) |
| 36 | +- Pressing any character while the ListBox has the focus will jump to |
| 37 | + the first listbox entry which starts with that character. |
| 38 | + |
| 39 | +#### Limitations |
| 40 | + |
| 41 | +- No parameter types shown for macros |
| 42 | + |
| 43 | + |
0 commit comments