2
2
# How to use plugin
3
3
4
4
### Check connection status
5
- To use plugin you should be connected to server, you can check
6
- the connection status in status bar:
5
+ You must be connected to server to use plugin. \
6
+ Connection status can be checked in the status bar.
7
7
8
8
![ ] ( images/plugin_usage/connectionStatus.png )
9
9
10
10
### Configure project and generate json files
11
- For test generation to work your project must be configured by server.
12
11
12
+ Your project must be configured by server to generate tests.
13
13
14
- To send request for project configuration or generation of json files
15
- click on connection status in the status bar and choose suitable option:
16
-
14
+ To send request for project configuration or json files generation,
15
+ click on ` connection status ` in the status bar and choose a suitable option:
17
16
18
17
![ ] ( images/plugin_usage/generateJson.png )
19
18
20
19
Plugin sends request for project configuration when you open
21
- the project. Sometimes configuration fails, and then after you changed
20
+ the project. Sometimes configuration fails, then after changing
22
21
your project you need to send the request for project configuration.
23
22
24
23
### Choose source folders
25
24
26
- The server needs to know under what folders source files are.
25
+ The server needs to know the folders source files are located in .
27
26
The source folders are marked with green icons in the project view:
28
27
29
28
![ ] ( images/plugin_usage/source-folders.png )
@@ -33,22 +32,23 @@ You can mark/unmark selected folders from context menu.
33
32
![ ] ( images/plugin_usage/mark-unmark-folders.gif )
34
33
35
34
### How to request tests generation
36
- Open a c/cpp file, right click in the text editor and in context menu
37
- choose suitable option:
35
+
36
+ Open a c/cpp file, right click in the text editor and
37
+ choose suitable option in the context menu:
38
38
39
39
![ editor actions] ( images/plugin_usage/editorActions.png )
40
40
41
- To generate tests for a folder right click on a folder in project view
41
+ For example, to generate tests for the folder, right click on it in the project view
42
42
and choose ` Generate for folder ` :
43
43
44
44
![ project view actions] ( images/plugin_usage/projectViewActions.png )
45
45
46
46
### See logs from server and client
47
- You can see what messages are sent to the server and server logging messages.
48
- For that click on the ` UTBot consoles ` tab in the bottom right corner:
47
+
48
+ You can see messages that are sent to the server and server own logging messages. Just click on the ` UTBot consoles ` tab in the bottom right corner:
49
49
50
50
![ UTBot consoles tab] ( images/plugin_usage/consolesTab.png )
51
51
52
- add choose the needed tab:
52
+ add choose the required tab:
53
53
54
54
![ UTBot consoles view] ( images/plugin_usage/consolesToolWindow.png )
0 commit comments