From 3273f26bb55a5efe8add5f31b3803c9de91c2be6 Mon Sep 17 00:00:00 2001 From: Basile Burg Date: Thu, 26 Jan 2017 00:36:06 +0100 Subject: [PATCH] doc --- docs/index.md | 1 + docs/options_application.md | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 docs/options_application.md diff --git a/docs/index.md b/docs/index.md index ad09380b..90503be7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,6 +35,7 @@ _Description of each entry in the main menu. May redirect to a specific widget p _Full description of Coedit options. May redirect to a specific widget page._ +* [Application](options_application) * [Code metrics](options_code_metrics) * [Compiler paths](options_compilers_paths) * [DUB build](options_dub_build) diff --git a/docs/options_application.md b/docs/options_application.md new file mode 100644 index 00000000..cbcba4c9 --- /dev/null +++ b/docs/options_application.md @@ -0,0 +1,25 @@ +--- +title: Widgets - application options +--- + +{% include xstyle.css %} + +The page exposes unsorted options. In the future some of them might be moved to their own category. + +![](img/options_application.png) + +- **additionalPATH**: Used to defined more paths were the background tools can be found. Each item must be separated by a path separator (`:` under Linux and `;` under Windows). +- **autoCheckUpdates**: If checked and if a newer release is available then a dialog proposes to redirect to the release page on github. +- **autoSaveProjectFiles**: If checked the sources are automatically saved before compilation. +- **coverModuleTests**: If checked then the coverage by the tests is measured and displayed in the messages after executing the action __File/Run file unittests__. +- **dcdPort**: Sets the port used by the [completion daemon](feaures_dcd) server. `0` means the default value. +- **dscanUnuttests**: If checked the content of the `unittest` blocks are analyzed when using the action __File/Verify with Dscanner__. +- **flatLook**: Doesn't draw the buttons shape unless they're hovered by the mouse. +- **floatingWidgetOnTop**: Keeps the widgets that are not docked on top of the application window. +- **maxReventDocuments**: Sets how many entries can be stored in __File/Open recent file__. +- **maxReventDocuments**: Sets how many entries can be stored in __Project/Open recent project__. +- **maxReventProjectsGroups**: Sets how many entries can be stored in __Projects group/Open recent group__. +- **nativeProjectCompiler**: Sets [which compiler](options_compilers_paths) is used to compile a project that has the [CE format](widgets_ce_project_editor). +- **reloadLastDocuments**: Sets if the sources, the project, and the group that were opened on exit are reloaded automatically. +- **showBuildDUration**: Sets if the duration of a project build is measured. +- **splitterScrollSpeed**: Sets how fast the splitters are moved when using the scroll wheel. \ No newline at end of file