forks
/
dexed
mirror of https://gitlab.com/basile.b/dexed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc

This commit is contained in:
Basile Burg 2016-12-30 05:37:50 +01:00
parent f20a576245
commit 3e1e274a04
No known key found for this signature in database
GPG Key ID: 1868039F415CB8CF
8 changed files with 61 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/features_dcd.md Normal file
View File

@ -0,0 +1,56 @@
---
title: D Completion Daemon
---
### D Dompletion Daemon
The D Completion Daemon (DCD) is used to accomplish IDE-grade features such as
- completion
![](img/dcd_completion.png)
- display function call tips
![](img/dcd_call_tips.png)
- display embedded documentation
![](img/dcd_ddoc.png)
- identifier renaming
![](img/dcd_renaming.png)
- jump to declaration
- redirection to html documentation
#### Setup
_DCD_ is a third part software, it's bundled in the archives distributed for each new [release](https://github.com/BBasile/Coedit/releases).
However, _DCD_ may have to be build manually, for example if a new version is released while _Coedit_ development is paused for a while.
Visit the product [homepage](https://github.com/Hackerpilot/DCD) for more information.
Note that since version 2 update 5, Coedit uses an experimental features that's not merged in the official repository.
If you wish to test it you must build [this clone](https://github.com/BBasile/DCD/tree/reboot-localusage), after checking out the right feature branch.
Once DCD build or extracted from the release archive, copy the two programs (_dcd-client_ and _dcd-server_) to the folder where the Coedit executable stands.
They can be put elsewhere, as long as the target directory is a known operating system PATH.
#### Imports
In _Coedit_, _DCD_ relies on the [compilers paths](options_compilers_paths), on the [library manager](widgets_library_manager) entries and on the project parameters. When the [_libman_](widgets_library_manager) is empty then the scope of DCD is limited to the symbols of current module, of the current project sources and of the standard library, that's why it necessary to register the development libraries used in the _libman_.
_DCD_ also has its own configuration system. Refer to the official [Readme](https://github.com/Hackerpilot/DCD#configuration-files).
#### Initialization
When Coedit starts and if the DCD server is not already listening then it's launched by CE.
When Coedit stops, the server is only terminated if it was not already running when starting.
If the DCD server crashes while Coedit is running then both must be restarted.
#### Usage
- <kbd>CTRL</kbd> + <kbd>SPACE</kbd>: Calls the completion menu or completes automatically if possible. The default shortcut can be modified in the [shortcut editor](options_shortcuts_editor).
- <kbd>.</kbd> invokes the completion if the editor option _autoDotDelay_ is greater than 0.
- <kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + <kbd>UP</kbd>: Jumps to the declaration of the symbol located at the cursor. The default shortcut can be modified.
- <kbd>CTRL</kbd> + <kbd>LEFT MOUSE BUTTON</kbd>: ditto.
- <kbd>(</kbd>: Gets the function call tips. When functions calls are nested, call tips are stacked and separated by a group of hyphen.
- <kbd>)</kbd>: If the call tips are displayed then decreases by one the stack of call tips.
- <kbd>ESC</kbd>: Closes the call tips window, whatever is the level of the stack.
- <kbd>CTRL</kbd> + <kbd>F2</kbd>: Renames the identifier for the symbol located at the cursor position. This works only if the symbol is declared in this module.
- <kbd>F1</kbd>: Displays the phobos documentation for the symbol that has the focus.
Documentation comments associated to a symbol are displayed when the cursor motion stops over a symbol.

BIN
docs/img/dcd_call_tips.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/img/dcd_completion.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB

BIN
docs/img/dcd_ddoc.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
docs/img/dcd_renaming.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

2
docs/index.md
View File

@ -6,6 +6,7 @@ title: index
#### Features
* [Completion deamon](features_dcd.md)
* [Projects](features_projects)
* [Runnable modules](features_runnables)
* [Symbolic strings](features_symbolic_strings)
@ -17,6 +18,7 @@ title: index
* [DUB build](options_dub_build)
* [Messages](widgets_messages)
* [Runnable modules](features_runnables)
* [Shortcuts editor](options_shortcuts_editor)
* [Symbol list](widgets_symbol_list)
#### Widgets

1
docs/options_shortcuts_editor.md Normal file
View File

@ -0,0 +1 @@

51
wiki/wiki.txt
View File

@ -1,3 +1,5 @@
Welcome to the Coedit Wiki, the documentation source for the small Windows & Linux IDE for the D programming language.
![](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/coedit.win7.33.png) ![](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/coedit.linux.kde.33.png)
@ -151,55 +153,6 @@ For discussions, the official D forums [propose a section dedicated to the IDEs]
- **"Verify with Dscanner"**: verifies the current file with [Dscanner](https://github.com/Hackerpilot/Dscanner). Results are displayed in the [message widget][lnk_widg_msg].
- **"View in mini explorer"**: expands the [mini-explorer][lnk_widg_miniexpl] tree on the folder that contains the current file.
# D Completion Daemon integration
The **D Completion Daemon** (DCD) is used for the completion, the function call tips, to find the declaration of a symbol and to display the _DDOC_ comment associated to a symbol.
### Setup
_DCD_ is a third part software, it's bundled in the archives distributed for each new [release](https://github.com/BBasile/Coedit/releases).
However, _DCD_ may have to be build manually, for example if a new version is released while _Coedit_ development is paused for a while.
Visit the product [homepage](https://github.com/Hackerpilot/DCD) for more information.
Note that since version 2 update 5, Coedit uses an experimental features that's not merged in the official repository.
If you wish to test it you must build [this clone](https://github.com/BBasile/DCD/tree/reboot-localusage), after checking out the right feature branch.
Once DCD build or extracted from the release archive, copy the two programs (_dcd-client_ and _dcd-server_) to the folder where the Coedit executable stands.
They can be put elsewhere, as long as the target directory is a known operating system PATH.
### Imports
In _Coedit_, _DCD_ relies on the [library manager][lnk_widg_lib] entries and on the project parameters.
If the [_libman_][lnk_widg_lib] is empty then the scope of DCD is limited to the current module or the to the current project sources and imports.
To avoid that, it's absolutely necessary to add at least _phobos_ and _core_ to the [_libman_][lnk_widg_lib] (if not automatically done the first time CE is executed).
_DCD_ also has its own configuration system. Refer to the official [_Readme_](https://github.com/Hackerpilot/DCD#configuration-files).
### Usage
- <kbd>CTRL</kbd> + <kbd>SPACE</kbd>: Calls the completion menu or auto-completes if possible. The default shortcut can be modified in the [shortcut editor][lnk_widg_opts].
- <kbd>.</kbd> invokes the completion if the editor option _autoDotDelay_ is greater than 0.
- <kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + <kbd>UP</kbd>: Jumps to the declaration of the symbol located at the cursor. The default shortcut can be modified.
- <kbd>CTRL</kbd> + <kbd>LEFT MOUSE BUTTON</kbd>: ditto.
- <kbd>(</kbd>: Gets the function call tips. When functions calls are nested, call tips are stacked and separated by a group of hyphen.
- <kbd>)</kbd>: If the call tips are displayed then decreases by one the stack of call tips.
- <kbd>ESC</kbd>: Closes the call tips window, whatever is the level of the stack.
- <kbd>CTRL</kbd> + <kbd>F2</kbd>: Renames the identifier for the symbol located at the cursor position. This works only if the symbol is declared in this module.
Documentation comments associated to a symbol are displayed when the cursor motion stops over a symbol.
![DCD completion](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/dcd1.png)
![DCD ddoc hint](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/dcd2.png)
![DCD call tip](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/dcd3.png)
When Coedit starts and if the DCD server is not already listening then it's launched by CE.
When Coedit stops, the server is only terminated if it was not already running when starting.
If the DCD server crashes while Coedit is running then both must be restarted.
It's also advisable to setup [Dscanner](https://github.com/Hackerpilot/Dscanner), from the same author, as a Coedit [custom tool][lnk_widg_tools].
# Docking
Coedit interface is divided into a small dozen of dockable widgets. Except the code editor, each widget