From c257cb4284ec99a0b7ffd4283939bad8611f5039 Mon Sep 17 00:00:00 2001 From: Basile Burg Date: Fri, 7 Jul 2017 15:35:26 +0200 Subject: [PATCH] doc --- docs/features_projects.md | 1 + docs/index.md | 2 +- docs/widgets_editor.md | 10 ++++++++++ icons/other/warning.png | Bin 0 -> 683 bytes 4 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 icons/other/warning.png diff --git a/docs/features_projects.md b/docs/features_projects.md index a8ddc6d8..d6e4d8b2 100644 --- a/docs/features_projects.md +++ b/docs/features_projects.md @@ -41,6 +41,7 @@ The widget used to edit the properties is the [CE project editor](widgets_ce_pro - **"Edit project file"**: Opens the project file in a new source editor. When saved from a source editor, a project file is directly reloaded. - **"View project command line"**: Displays the list of switches and arguments, as they would be passed to the compiler (or the build tool) when compiling. - **"View in mini explorer"**: Expands the [mini-explorer](widgets_mini_explorer) tree on the folder that contains the project file. +- **"Verify project with Dscanner"**: Performs some static checks on each source of the project and using [Dscanner](https://github.com/dlang-community/D-Scanner). - **"Compile project"**: Compiles the project using the current configuration. - **"Compile and run project"**: Compiles the project using the current configuration and executes the output when the binary produced is executable. - **"Compile and run project..."**: Ditto. Before the execution of the binary an input query dialog lets you pass options to the process. diff --git a/docs/index.md b/docs/index.md index 5b3ad507..3c91f0a7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ title: index ![](img/coedit_kde4_thumb.png) -This documentation is based on version 3, update 2. +This documentation is based on version 3, update 3. #### First steps diff --git a/docs/widgets_editor.md b/docs/widgets_editor.md index 087d1919..e1acec77 100644 --- a/docs/widgets_editor.md +++ b/docs/widgets_editor.md @@ -104,6 +104,14 @@ When a document that's edited in Coedit is modified by another program, a _diff_ The dialog is guaranteed to be only displayed when the content contains changes. A simple date of modification has no effect. +#### Linting + +If activated in the options (see beyond), the source can be automatically linted, after a relative period of time, following the last keystroke. +Results are displayed in the gutter and the warning body can be consulted in the hint displayed when the mouse motin stops over the icon. +Linting requires [D-Scanner](https://github.com/dlang-community/D-Scanner) to be setup. +It's possible to use the [information box](widgets_about) to determine if Coedit can find the tool. +Note that linting can also be launched manually from the _File_ or the _Project_ menus. + #### Notable options The editor is highly configurable. @@ -126,6 +134,8 @@ The shortcuts are editable in the [shortcut editor](options_shortcuts_editor), u - **closeCompletionCharsWithSapce**: Defines the characters that, in addition to close the completion menu, are inserted after the proposal and a space. - **currentLine**: Defines the visual style applied to the current line. - **ddocDelay**: Sets, in milliseconds, how responsive is the popup that displays the inline documentation. +- **dscannerDelay**: Sets, in milliseconds, the delay between the last keystroke and a call to the linter (if enabled). +- **dscannerEanbled**: Sets if the linter D-Scanner is enabled. - **detectIndentMode**: If checked the the indentation style (tabs or spaces) is detected when a document is opened. It's applied automatically when TAB is used. - **folding**: Sets the code regions that can be folded in the gutter. - **lineNumberEvery**: Sets the frequency of the line numbers in the gutter. diff --git a/icons/other/warning.png b/icons/other/warning.png new file mode 100644 index 0000000000000000000000000000000000000000..219432c44d6d57179930a1f307e3c48e89afc4ab GIT binary patch literal 683 zcmV;c0#yBpP)9ZU- zJm)h#N36B9OZl!8l{jy(t%?rAOVLMmqg_w6eGMq>y)vcgVLftjGBlAF9eeFAD|h6A zE}R^fL{3yPr&Mn2T8*$-E~ff=U-q*n`~fdev1JxTbp*C|xhmOVUs`ok zzR29t3Uf;<=zIxfo7nVFZtFWUZGo+8;x%;gK_u#V;(Dmm5wgBRt}BAd^db=#H}1!q z5?flkA?`mwMYt95bB+$G=>9QmP@|A`C}bRLYaiV|foat+iSC#*xqblnbVV{P9i2tL!53jp$NhCXHZJksZSZf_Ci#QEQYK%adAKLHL=TMO?5xw}p?AtWG(o^r zGKvGxc)xmJ7U^GS{qOYvaThoE#u-y@^77*b3)bSc>2-_<`yxD(PT%>k`3YlFonmk< R;ST@+002ovPDHLkV1l9fDaHT* literal 0 HcmV?d00001