Doc and build script updates

This commit is contained in:
Hackerpilot 2014-01-20 04:32:06 -08:00
parent 87056b0c58
commit 225b10a528
4 changed files with 20 additions and 10 deletions

View File

@ -99,12 +99,21 @@ When the first line of output is "calltips", the editor should display a functio
call tip. call tip.
#####Output format #####Output format
A line containing the string "calltips", followed by zero or more lines, each A line containing the string "calltips", followed by zero or more lines, each
containing a call tip for an overload of the given function as well as its containing a call tip for an overload of the given function.
DDoc comment, if available. Be sure to escape the \n sequences to newlines
when implementing an editor plugin.
#####Example output #####Example output
calltips calltips
Some DDoc comment\nspread over two lines\n\nACSymbol findSymbolInCurrentScope(size_t cursorPosition, string name) ACSymbol findSymbolInCurrentScope(size_t cursorPosition, string name)
## Doc comment display
```dcd-client --doc
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
functions there can be more than one documentation comment associated with a
symbol. One doc comment will be printed per line. Newlines within the doc
comments will be replaced with "\n".
####Example output
An example doc comment\nParams: a = first param\n Returns: nothing
An example doc comment\nParams: a = first param\n b = second param\n Returns: nothing
##Clear server's autocomplete cache ##Clear server's autocomplete cache
```dcd-client --clearCache``` ```dcd-client --clearCache```

View File

@ -1,3 +1,3 @@
dmd -wi client.d messages.d msgpack-d/src/msgpack.d -Imsgpack-d/src -release -inline -noboundscheck -O -ofdcd-client.exe dmd -wi client.d messages.d msgpack-d/src/msgpack.d -Imsgpack-d/src -release -inline -noboundscheck -O -ofdcd-client.exe
dmd actypes.d astconverter.d autocomplete.d constants.d messages.d modulecache.d semantic.d server.d stupidlog.d dscanner/stdx/d/ast.d dscanner/stdx/d/parser.d dscanner/stdx/lexer.d dscanner/stdx/d/lexer.d dscanner/stdx/d/entities.d dscanner/formatter.d datapicked/dpick/buffer/buffer.d datapicked/dpick/buffer/traits.d msgpack-d/src/msgpack.d -Imsgpack-d/src -Idscanner -Idatapicked -wi -g -ofdcd-server.exe dmd -wi actypes.d astconverter.d autocomplete.d constants.d messages.d modulecache.d semantic.d server.d stupidlog.d dscanner/stdx/d/ast.d dscanner/stdx/d/parser.d dscanner/stdx/lexer.d dscanner/stdx/d/lexer.d dscanner/stdx/d/entities.d dscanner/formatter.d msgpack-d/src/msgpack.d -Imsgpack-d/src -Idscanner -O -release -noboundscheck -inline -ofdcd-server.exe

View File

@ -2,10 +2,7 @@ dmd -wi client.d\
messages.d\ messages.d\
msgpack-d/src/msgpack.d\ msgpack-d/src/msgpack.d\
-Imsgpack-d/src\ -Imsgpack-d/src\
-release\ -release -inline -noboundscheck -O\
-inline\
-noboundscheck\
-O\
-ofdcd-client -ofdcd-client
dmd \ dmd \

View File

@ -176,6 +176,10 @@ Options:
Get the file name and position that the symbol at the cursor location Get the file name and position that the symbol at the cursor location
was defined. was defined.
--doc | -d
Gets documentation comments associated with the symbol at the cursor
location.
-IPATH -IPATH
Instructs the server to add PATH to its list of paths searced for Instructs the server to add PATH to its list of paths searced for
imported modules. imported modules.