Skip to content

Commit e302404

Browse files
committed
tweak documentation
VDServer.cs: remove debug message box
1 parent 9ee361a commit e302404

File tree

5 files changed

+86
-14
lines changed

5 files changed

+86
-14
lines changed

doc/Editor.dd

Lines changed: 67 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,34 +50,91 @@ $(PRE
5050
string
5151
)
5252

53-
$(H2 More features)
53+
$(H2 Code Completion and Navigation)
54+
$(P Selecting "Open Language options" from the Visual D Menu will take you directly to the global options page
55+
for code completion.
56+
)
57+
$(IMG_CENTER images/intellisense_options2.png)
5458

59+
This is where you can configure what happens if you want to see code completion.
5560

56-
You might want to check the following features:
5761
$(UL
58-
$(LI simple word-completion will show identifiers in the vicinity of the caret from the same buffer (default short-cut Ctrl-Space). If you press the short-cut again, identifiers from JSON files are also displayed.)
59-
$(LI import statement completion: pressing Ctrl-Space in an import statement will complete the token from the files and folders available in the import directories.
62+
$(LI Expansions from semantic analysis:
63+
the semantic engine will try its best to figure out the current scope of the edited text and
64+
find valid identifiers. If no matching identifier is found or if you trigger expansion again,
65+
expansions from the text buffer or JSON browse information will be added.
66+
)
67+
$(LI Expansions from text buffer:
68+
completion will show identifiers in the vicinity of the caret from the same buffer
69+
(default short-cut Ctrl-Space). If no matching identifier is found or if you press the short-cut
70+
again, identifiers from JSON files are also displayed.
71+
)
72+
$(LI Expansions from JSON browse information:
73+
completion will show matching identifiers from the compiler generated JSON files. No information
74+
about the current edit scope will be used.
75+
)
76+
$(LI Show expansion when: sets the trigger for showing the code completion popup. Using a mode
77+
that displays completion more often also includes the other triggers, i.e. hitting Ctrl+Space is
78+
always possible to display completions.
79+
)
80+
$(LI Show type of expressions in tool tip:
81+
Display information about the hovered identifier in a tool tip.
82+
)
83+
$(LI Use semantic analysis for "Goto Definition":
84+
goto definition (default short-cut F12) can either request the location of the definition of
85+
a symbol from the semantic engine or takes information from compiler generated JSON files.
86+
A successful build with JSON output enabled is necessary for the laytter. JSON files can also
87+
be precompiled and placed into the directories given in the $$(DDLINK GlobalOptions,global options).
88+
If there are multiple
89+
definitions for the identifier at the caret position, the $(DDLINK Search,Search Window) will show up.
90+
)
91+
$(LI Use Alexander Bothe's D parsing engine:
92+
Use the semantic engine that also powers Mono-D and D-IDE. It is more powerful than the
93+
engine that is part of Visual D. You must have installed it from within the Visual D installer.
94+
)
95+
)
96+
97+
$(P Triggering completion an import statement will always complete the token from the files and folders available
98+
in the import directories.
6099
$(IMG_CENTER images/import_completion.png)
61100
)
62-
$(LI goto definition (default short-cut F12) takes information from compiler generated JSON files. A successful build with JSON output enabled is necessary for this function. JSON files can also be precompiled and placed into the directories given in the global options. If there are multiple definitions for the identifier at the caret position, the [wiki:Tour/Search Search Window] will show up.)
101+
102+
$(H2 More features)
103+
104+
You might want to check the following features:
105+
$(UL
63106
$(LI smart indentation will indent nicely after pressing Return. )
64107
$(LI comment/uncomment a selection of lines)
65108
$(LI highlight/jump-to matching braces (default shortcut Ctrl-$(ACUTE)))
66-
$(LI code snippets: let's you select from a list of snippets, some of them allowing token replacements (default shortcut Ctrl-K Ctrl-X). You can also insert code-snippets by writing its shortcut, then pressing the key for command "Edit.!InvokeSnippetFromShortcut". For example, shortcut "for" yields
109+
$(LI code snippets: let's you select from a list of snippets, some of them allowing token
110+
replacements (default shortcut Ctrl-K Ctrl-X). You can also insert code-snippets by writing its
111+
shortcut, then pressing the key for command "Edit.!InvokeSnippetFromShortcut". For example,
112+
shortcut "for" yields
67113
$(IMG_CENTER images/codesnippet.png)
68114
)
69-
$(LI parameter info tooltips (default short-cut Ctrl-Shift-Space) showing function prototype and highlighting current position in argument list. As with "goto definition" this feature relies on JSON files being generated.
115+
$(LI parameter info tooltips (default short-cut Ctrl-Shift-Space) showing function prototype and
116+
highlighting current position in argument list. As with "goto definition" this feature relies
117+
on JSON files being generated.
70118
$(IMG_CENTER images/parameterinfo.png)
71119
)
72-
$(LI show scope in status line: to avoid navigating through a larger file to figure out what class the current function belongs to, command "VisualD.!ShowScope" displays the class, function, etc. at the caret position:
120+
$(LI show scope in status line: to avoid navigating through a larger file to figure out what
121+
class the current function belongs to, command "VisualD.ShowScope" displays the class, function,
122+
etc. at the caret position:
73123
$(IMG_CENTER images/showscope.png)
74124
This command is also accessible from the Visual D menu, but it is best to assign it to some keyboard shortcut.
75125
)
76126
$(LI Outlining of curly braced declarations and statements and multi-line comments
77127
$(IMG_CENTER images/outlining.png)
78-
Automatic outlining can be disabled on the global configuration page "Tools->Options->Text Editor->D->Colorizer". Using command "Outlining->Collapse to Definitions" will enable it for the current text buffer.
128+
Automatic outlining can be disabled on the global configuration page
129+
"Tools->Options->Text Editor->D->Colorizer". Using command "Outlining->Collapse to Definitions"
130+
will enable it for the current text buffer.
79131
)
80-
$(LI show the clipboard ring in a context menu to paste from. This operation is invoked by the "Edit->Cycle Clipboard Ring" command.
132+
$(LI Two commands are added to the "Edit->Outlining" menu: "Collapse unittests" will fold away
133+
unittest blocks that might obfuscate the actual code if they become excessive. "Collapse disabled code"
134+
will hide code blocks actually not compiled due to version or debug conditions helping you concentrate on
135+
the active code.)
136+
$(LI show the clipboard ring in a context menu to paste from. This operation is invoked by
137+
the "Edit->Cycle Clipboard Ring" command.
81138
$(IMG_CENTER images/pastemenu.PNG)
82139
)
83140
)

doc/GlobalOptions.dd

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,26 @@ $(UL
3535
that the compiler is found as <DMD install path>\bin\ldc2.exe )
3636
)
3737
)
38-
$(LI Executable paths: Directories to be added to the PATH environment variable before executing build commands.)
3938
$(LI Import paths: Directories to be added to the import paths specified in the project configuration and in the
4039
DMD configuration file (also used for import statement completion and finding symbol definition).)
40+
$(LI Executable paths: Directories to be added to the PATH environment variable before executing build commands.)
4141
$(LI Library paths: Directories to be added to the LIB environment variable before executing build commands.)
4242
)
43-
43+
Executable and library search paths are given depending on the target architecture. When using DMD for Win64,
44+
options from its configuration file can be overwritten by specifying the linker to be used and additional options.
45+
$(UL
46+
$(LI override sc.ini: $(P The latest Windows installer for DMD modifies the default sc.ini by expanding variables
47+
according to the most recent Visual C++ installation and Windows SDK installation directories. This is necessary
48+
to allow building Win64 executables from the command line without having additional environment variables set.
49+
Unfortunately this makes it difficult to use libraries from the current Visual C++ installation if you have
50+
multiple Visaul Studio versions installed.
51+
)
52+
$(P Enabling this option allows to override the linker settings from sc.ini. At the same time the
53+
library search paths are added to the command line.
54+
Also note that using a 32-bit linker executable is necessary to monitor link dependencies.
55+
)
56+
)
57+
)
4458
$(P Available text replacements: )
4559
$(UL
4660
$(LI $(DOLLAR)(DMDINSTALLDIR): DMD Install path from the "DMD directories page" )
@@ -49,12 +63,13 @@ $(UL
4963
$(LI $(DOLLAR)(WINDOWSSDKDIR): Windows SDK Directory )
5064
$(LI $(DOLLAR)(DEVENVDIR): Directory of Visual Studio executable devenv.exe )
5165
$(LI $(DOLLAR)(VSINSTALLDIR): Root directory of Visual Studio installation )
66+
$(LI $(DOLLAR)(VCINSTALLDIR): The directory of the Visual C installation that comes with the running Visual Studio)
5267
$(LI $(DOLLAR)(VISUALDINSTALLDIR): Installation folder of Visual D )
5368
$(LI any variable from the system environment enclosed in $(DOLLAR)() )
5469
)
5570

5671
$(P Please note that you'll also find a new entry "D" in the Text Editor branch to setup
57-
[wiki:Tour/Editor syntax highlighting] and more. )
72+
$(DDLINK Editor,syntax highlighting) and more. )
5873

5974
Macros:
6075
TITLE=Global Options

doc/images/dmd_directories.png

15.1 KB
Loading
21.6 KB
Loading

vdc/abothe/VDServer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ public void ConfigureSemanticProject(string filename, string imp, string stringI
154154
}
155155
public void ClearSemanticProject()
156156
{
157-
MessageBox.Show("ClearSemanticProject()");
157+
//MessageBox.Show("ClearSemanticProject()");
158158
//throw new NotImplementedException();
159159
}
160160
public void UpdateModule(string filename, string srcText, bool verbose)

0 commit comments

Comments
 (0)