diff --git a/docs/build.md b/docs/build.md index 17e4b9e6..a35b7015 100644 --- a/docs/build.md +++ b/docs/build.md @@ -37,6 +37,7 @@ The background tool used by the IDE is a D program. * In the repository, browse to the `dastworx` folder. * Windows: double click `build.bat` * Linux: `sh ./build.sh` + You can also build it in CE using the project file _dastworx.ce_. #### Third party tools: diff --git a/docs/features_runnables.md b/docs/features_runnables.md index 114ce7bd..e926db81 100644 --- a/docs/features_runnables.md +++ b/docs/features_runnables.md @@ -23,7 +23,7 @@ Two typical scenarios: - the runnable will be debugged so DWARF information must be generated with `-g`. - the runnable must be linked with a C static library so the linker flag `-L-lthelib` must be specified. -Coedit doesn't handle the program specified after the She-Bang, which means that any of the following script lines are valid: +Coedit doesn't handle the program specified after the She-Bang, which means that all the following script lines are valid: - `#!runnable-flags: --whatever` - `#!usr/bin/dmd --whatever` @@ -43,12 +43,12 @@ When the program is not run outside, the [process input widget](widgets_process_ To be runnable, a module must verify: -- a `void main()` is present. +- a `void main()` is present or the option to automatically detect the `main()` function is activated. - the modules to import must be known, either by the [library manager](widgets_library_manager) or by the compiler configuration file. - _import expressions_ ( `import(file);` ) are allowed if _file_ stands in the same folder as the module being edited. The _Compile file and run outside_ action can be used to execute in an external console. -This must be used if the runnable outputs thousands of lines, to display properly UTF8 characters or if it has a GUI. +It must be used if the runnable outputs thousands of lines, to display properly UTF8 characters or if it has a GUI. The version identifier **runnable_module** is automatically defined when a runnable is compiled. It can be used to adjust the source according to the execution context, for example: diff --git a/docs/setup.md b/docs/setup.md index 1b82be94..8847cbf2 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -13,7 +13,7 @@ In all the cases, the _DMD_ D2 compiler must setup and its location has to match If it's not already installed, [download](http://dlang.org/download.html) and setup DMD2 for your platform. The latest Coedit version requires at least DMD 2.072. -For each platform Coedit can be setup from using a setup program or by extracting the binaries. +For each platform Coedit can be setup using a setup program or by extracting the binaries. ### Setup program diff --git a/docs/widgets_about.md b/docs/widgets_about.md index 8003f535..037b5eaa 100644 --- a/docs/widgets_about.md +++ b/docs/widgets_about.md @@ -12,9 +12,4 @@ The status of each tool is indicated: - : The tool is well detected. - : The tool cannot be found but it's not necessary. Expect some features not to work properly even if the software is still usable. -- : The tool cannot be found but it's necessary. The software is not usable. This happens when a the tool location is not indicated by a PATH entry. - - - - - +- : The tool cannot be found but it's necessary. The software is not usable. This happens when the tool cannot be located using the PATH variable. diff --git a/docs/widgets_ce_project_editor.md b/docs/widgets_ce_project_editor.md index 5ac25bbc..71380edd 100644 --- a/docs/widgets_ce_project_editor.md +++ b/docs/widgets_ce_project_editor.md @@ -11,8 +11,8 @@ The widget is used to edit the properties of a project that has the CE (Coedit) ![](img/ce_project_editor.png) -The format is modeled from DMD command line interface but it can be compiled with LDC or GDC too, -using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD). +The format is modeled based on the DMD command line interface but it can be compiled with LDC or GDC too, +using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD), which is done automatically when they are [set to compile CE the projects](options_application). #### Toolbar @@ -21,10 +21,11 @@ using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD). - : Clones the current compiler configuration. - / : De/activates the synchro-mode. When activated, each particular option edited will be copied to the other configurations. -Notes: +Notes: + - changing the configuration name is only possible in the section _All Categories_, field _name_. -#### General options: +#### General options The general options are common to each configuration. @@ -38,7 +39,7 @@ When dependencies are complex, it's possible to select all the entries by settin It's recommended to use the [project inspector](widgets_project_inspector) instead of this archaic editor. To include a folder of source it's also possible to specify a path with a asterisk in the **Paths** options, **ExtraSources** editor. This avoids to manually remove the obsolete source or to manually add the new source files. -#### Message options: +#### Message options Groups the options related to the messages emitted by the compiler. These options are defined per-configuration. @@ -52,7 +53,7 @@ These options are defined per-configuration. - **warnings**: Sets if the warnings are displayed. (**-w**) - **warningsAsInfo**: Defines if the warnings don't prevent the project to be compiled. -#### Debugging options: +#### Debugging options Groups the options related to the debugging information added to the output binary. These options are defined per-configuration. @@ -64,7 +65,7 @@ These options are defined per-configuration. - **debugIdentifiers**: List of debug identifiers. (for each item **-debug=item** is generated). One item per line. - **generateMapFile**: sets if a map file is generated. (**-map**) -#### Documentation options: +#### Documentation options Groups the options related to the generation of the project documentation. These options are defined per-configuration. @@ -74,7 +75,7 @@ These options are defined per-configuration. - **generateJSON**: Sets if the JSON documentation is generated. This field is constrained to _true_ if the JSON file name is defined. (**-X**) - **JSONFilename**: Sets the JSON file name. (**-Xf**) -#### Output options: +#### Output options Groups the options related to the code generation. These options are defined per-configuration. @@ -91,7 +92,7 @@ These options are defined per-configuration. - **unittest**: generates the unittest code. (**-unittest**) - **versionIdentifiers**: list of version identifiers. One per line, the switches **-version=** are added automatically. An entry can be disabled by prefixing it with a semicolon or a pair of backslash. -#### Other Options: +#### Other Options - **coverage**: Adds the code to generate coverage file after the output gets executed. - **customOptions**: Allows to add custom options, whatever is the compiler used. @@ -109,7 +110,7 @@ Syntax for the custom / other options: These custom switches are defined per-configuration. -#### Path options: +#### Path options Groups the options defining the location of the files used or produced by the compiler. These options are defined per-configuration. @@ -122,7 +123,7 @@ These options are defined per-configuration. - **objectDirectory**: The directory where object files (_*.o_ or _*.obj_) must be written. (**-od**) - **outputFilename**: The output filename. The identifier should only include a period to specify a non default extension otherwise it prevents _DMD_ to add the default one. (**-of**) -#### Pre/Post build process options: +#### Pre/Post build process options They define the options of two processes and a bunch of commands, respectively executed before and after the compilation. These options are defined per-configuration. @@ -142,7 +143,7 @@ This can be used as a trick to compile from another tool. An interesting post-build process feature is that it can be set on the executable that's just been build. This is possible when the post compilation process _executable_ is set to the [symbolic strings](features_symbolic_strings) **``**, which is expanded to the name of the file produced by the compiler. -#### Run options: +#### Run options They define the options applied when running the project output (e.g: menu **"project"**, **"compile and run"**). The _executable_ field is not present because it relies on the project parameters (**-of** for a CE project and the combination of _targetPath_ with _targetName_ for a DUB project). diff --git a/docs/widgets_dub_project_editor.md b/docs/widgets_dub_project_editor.md index 358bc30b..308b6084 100644 --- a/docs/widgets_dub_project_editor.md +++ b/docs/widgets_dub_project_editor.md @@ -6,8 +6,8 @@ title: Widgets - DUB project editor ### DUB project editor -The DUB project editor allows to edit, add and remove properties of DUB projects that has the [JSON format](http://code.dlang.org/package-format?lang=json). -DUB projects with the [SDL format](http://code.dlang.org/package-format?lang=sdl) are read only. +The DUB project editor allows to edit, add and remove properties to a a DUB project that has the [JSON format](http://code.dlang.org/package-format?lang=json). +DUB projects with the [SDL format](http://code.dlang.org/package-format?lang=sdl) are opened in read only mode. ![](img/dub_project_editor.png) diff --git a/docs/widgets_editor.md b/docs/widgets_editor.md index f34a47ab..3a2bfa8b 100644 --- a/docs/widgets_editor.md +++ b/docs/widgets_editor.md @@ -35,7 +35,7 @@ All these actions are assignable to a shortcut via the [shortcut editor](options Options exist to automatically close the curly brackets (`{ }`), the square brackets (`[ ]`), the parenthesis (`( )`) the double quotes (`" "`), the back-ticks and the single quotes. -The way the right curly bracket is insert can be tweaked. For the other symbols the feature is always either individually on or off. +The way the right curly bracket is inserted can be tweaked. For the other symbols the feature is always either individually on or off. Options for the curly brackets: diff --git a/docs/widgets_mini_explorer.md b/docs/widgets_mini_explorer.md index 179938fc..78efbde8 100644 --- a/docs/widgets_mini_explorer.md +++ b/docs/widgets_mini_explorer.md @@ -8,7 +8,7 @@ title: Widgets - mini explorer #### Description -The mini explorer provides basic file browsing within the IDE. +The mini explorer provides basic file browsing functionality within the IDE. ![](img/mini_explorer.png)