forks
/
DCD
mirror of https://github.com/dlang-community/DCD.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

readme: mention the DC env variable, typo, ident (#567) 

readme: mention the DC env variable, typo, ident
merged-on-behalf-of: BBasile <BBasile@users.noreply.github.com>
This commit is contained in:
BBasile 2018-12-31 01:22:38 +01:00 committed by The Dlang Bot
parent b764ad2486
commit a163e33beb
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -38,7 +38,8 @@ the issue.)
* Not working: * Not working:
* UFCS suggestions * UFCS suggestions
* Autocompletion of declarations with template arguments (This will work to some extent, but it won't do things like replace T with int) * Autocompletion of declarations with template arguments (This will work to some extent, but it won't do things like replace T with int)
* Determining the type of an enum member when no base type is specified, but the first member has an initialaizer * Determining the type of an enum member when no base type is specified, but the first member has an initializer
* auto functions (which can then propagate the failure to auto declarations)
* That one feature that you *REALLY* needed * That one feature that you *REALLY* needed
# Setup # Setup
@ -51,9 +52,10 @@ the issue.)
### Git + Make ### Git + Make
1. Install a recent D compiler. DCD is tested with DMD 2.068.2, DMD 2.069.0-rc2, and LDC 0.16 (Do not use DMD 2.068.1) 1. Install a recent D compiler.
1. Run `git submodule update --init --recursive` after cloning this repository to grab the various dependencies. 1. Run `git submodule update --init --recursive` after cloning this repository to grab the various dependencies.
1. Run `make` to build the client and server. (Or run build.bat on Windows). `make ldc` and `make gdc` will use the LDC or GDC compilers. The resulting executable will be much faster. 1. Optionally set the environment variable `DC` if you wish to use another compiler than the DMD known by the system.
1. Run `make` to build the client and server. (Or run build.bat on Windows).
### OS X w/ Homebrew ### OS X w/ Homebrew
@ -175,7 +177,7 @@ a tab separated format:
libraryFunction f Tuple!long libraryFunction(string s, string s2) stdin 190 foobar libraryFunction f Tuple!long libraryFunction(string s, string s2) stdin 190 foobar
libraryFunction f int* libraryFunction(string s) stdin 99 Hello\nWorld libraryFunction f int* libraryFunction(string s) stdin 99 Hello\nWorld
libraryVariable v int libraryVariable stdin 56 My variable libraryVariable v int libraryVariable stdin 56 My variable
libreTypes g stdin 298 libreTypes g stdin 298
#### Note #### Note
@ -201,7 +203,7 @@ containing a call tip for an overload of the given function.
## Doc comment display ## Doc comment display
dcd-client --doc -c 4298 dcd-client --doc -c 4298
When run with the --doc or -d option, DCD will attempt to display documentation When run with the --doc or -d option, DCD will attempt to display documentation
comments associated with the symbol at the cursor position. In the case of comments associated with the symbol at the cursor position. In the case of
functions there can be more than one documentation comment associated with a functions there can be more than one documentation comment associated with a
@ -294,7 +296,7 @@ Otherwise the client outputs _00000_ so that the length of the answer is guarant
#### Example output #### Example output
stdin 45 stdin 45
26 26
45 45
133 133