From b25dba054926cad4c0eb859b066d43fa22a4d454 Mon Sep 17 00:00:00 2001 From: Simon Barner <barner@fortiss.org> Date: Wed, 4 Jul 2018 15:48:12 +0200 Subject: [PATCH] Developer documentation for tooling base UI. Issue-Ref: 3401 Issue-Url: https://af3-developer.fortiss.org/issues/3401 Signed-off-by: Simon Barner <barner@fortiss.org> --- .../html/developer/.ratings | 2 +- .../html/developer/documentation.html | 28 ++++++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/org.fortiss.tooling.base.ui/html/developer/.ratings b/org.fortiss.tooling.base.ui/html/developer/.ratings index 2936766b2..4e32de075 100644 --- a/org.fortiss.tooling.base.ui/html/developer/.ratings +++ b/org.fortiss.tooling.base.ui/html/developer/.ratings @@ -1 +1 @@ -documentation.html 537e8465aeba8ae2710474486b811f59a3dbd45c RED +documentation.html 2588c92dc58129eb36ca852901128599f9140ffa YELLOW diff --git a/org.fortiss.tooling.base.ui/html/developer/documentation.html b/org.fortiss.tooling.base.ui/html/developer/documentation.html index 537e8465a..2588c92dc 100644 --- a/org.fortiss.tooling.base.ui/html/developer/documentation.html +++ b/org.fortiss.tooling.base.ui/html/developer/documentation.html @@ -1,4 +1,30 @@ <html><body> <H1>Developer Documentation for <I>org.fortiss.tooling.base.ui</I></H1> -<P>// TODO +<p>This plugin provides a base implementation for graphical editors using the GEF framework +(to be replaced with a JavaFX based implementation).</p> + +<p>It contains the following main packages: +<ul> +<li><code>annotation</code>: +GUI support of annotation framework. +<ul> +<li><code>editingsupport</code>: contains editing support to edit annotations into the generic table-based annotation view.</li> +<li><code>labelprovider</code>: contains label providers support to display annotations in the generic table-based annotation view.</li> +<li><code>view</code>: provides abstract base classes and a generic table-based view part to display and edit annotations.</li> +</ul> +</li> +<li><code>databinding</code>: Eclipse data binding support.</li> +<li><code>dialog</code>: Basic dialog classes.</li> +<li><code>dnd</code>: JFace and GEF-based drag'n'drop.</li> +<li><code>editor</code>: various (model) editors</li> +<li><code>editpart</code>: GEF edit part base classes.</li> +<li><code>fieldassist</code>: Auto-completion support.</li> +<li><code>javafx</code>: JavaFX-based UI support (under development).</li> +<li><code>layout</code>: Diagram layout configurations, including automatic layout.</li> +<li><code>utils</code>: Utility classes.</li> +<li><code>viewers</code>: Editor editing support and label providers.</li> + +</ul> + +</p> </body></html> -- GitLab