From d85c16ed4a03a4da7f419d7af2bd1762b4c10477 Mon Sep 17 00:00:00 2001 From: Simon Barner <barner@fortiss.org> Date: Wed, 4 Jul 2018 14:36:41 +0200 Subject: [PATCH] Developer documentation for kernel 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 | 25 ++++++++++++++++--- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/org.fortiss.tooling.kernel.ui/html/developer/.ratings b/org.fortiss.tooling.kernel.ui/html/developer/.ratings index 9ce98f51f..ee92c198a 100644 --- a/org.fortiss.tooling.kernel.ui/html/developer/.ratings +++ b/org.fortiss.tooling.kernel.ui/html/developer/.ratings @@ -1 +1 @@ -documentation.html 4c96abcfe1108147602c98156ca5d755d65f9d96 RED +documentation.html d880343666d4764c27186bcbc4d12b5d3106a9a9 YELLOW diff --git a/org.fortiss.tooling.kernel.ui/html/developer/documentation.html b/org.fortiss.tooling.kernel.ui/html/developer/documentation.html index 4c96abcfe..d88034366 100644 --- a/org.fortiss.tooling.kernel.ui/html/developer/documentation.html +++ b/org.fortiss.tooling.kernel.ui/html/developer/documentation.html @@ -1,4 +1,21 @@ -<html><body> -<H1>Developer Documentation for <I>org.fortiss.tooling.kernel.ui</I></H1> -<P>// TODO -</body></html> +<html> +<body> +<h1>Developer Documentation for Tooling Kernel UI (<i>org.fortiss.tooling.kernel.ui</i>)</h1> + +<p> +This plugin provides the UI related kernel services +<ul> +<li><code>IActionService</code>: registration and management of actions</li> +<li><code>IAllocationEditPartFactoryService</code>: allocations between any two graphical editors.</li> +<li><code>IConstraintUIService</code>: Constraints UI support.</li> +<li><code>IContextMenuService</code>: model element specific context menus</li> +<li><code>IEditPartFactoryService</code>: edit part factories</li> +<li><code>IMarkerService</code>: markers to display results obtained from <code>IConstraintCheckerService</code></li> +<li><code>IModelEditorBindingService</code>: Opening and closing of editors</li> +<li><code>IModelElementHandlerService</code>: element "handling" (i.e., retrieving +information such as name, icon, ..., etc. about model elements)</li> +<li><code>INavigatorService</code>: Model element navigator</li> +<li><code>ITutorialUIService</code>: Tutorial mode UI support</li> +</ul> +</body> +</html> \ No newline at end of file -- GitLab