From 2ee72de975248815da4c7d008f287283e5086d8b Mon Sep 17 00:00:00 2001
From: Simon Barner <barner@fortiss.org>
Date: Wed, 4 Jul 2018 12:04:01 +0200
Subject: [PATCH] Developer documentation for tooling Common [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          | 18 ++++++++++++++----
 .../html/developer/.ratings                    |  2 +-
 .../html/developer/documentation.html          | 16 ++++++++++++----
 4 files changed, 28 insertions(+), 10 deletions(-)

diff --git a/org.fortiss.tooling.common.ui/html/developer/.ratings b/org.fortiss.tooling.common.ui/html/developer/.ratings
index eb1fb2b84..6c3900f40 100644
--- a/org.fortiss.tooling.common.ui/html/developer/.ratings
+++ b/org.fortiss.tooling.common.ui/html/developer/.ratings
@@ -1 +1 @@
-documentation.html 3faeacedf3cef9ba009cf11f57f8965a911e17c9 RED
+documentation.html faee8f84244142ee4d64f26068492f4ebd27b75b YELLOW
diff --git a/org.fortiss.tooling.common.ui/html/developer/documentation.html b/org.fortiss.tooling.common.ui/html/developer/documentation.html
index 3faeacedf..faee8f842 100644
--- a/org.fortiss.tooling.common.ui/html/developer/documentation.html
+++ b/org.fortiss.tooling.common.ui/html/developer/documentation.html
@@ -1,4 +1,14 @@
-<html><body>
-<H1>Developer Documentation for <I>org.fortiss.tooling.common.ui</I></H1>
-<P>// TODO
-</body></html>
+<html>
+<body>
+<h1>Developer Documentation for Tooling Common UI (<i>org.fortiss.tooling.common.ui</i>)</h1>
+
+This plugin bundles the following:
+<ul>
+<li>UI code that is independent of modeling</li>
+<li>Base classes for UI frameworks such as SWT, JFace, GEF, GMF, and JavaFX </li>
+<li>Plugin dependencies for the aforementioned UI frameworks.</li>
+<li>External libraries that are shared between multiple plugins.</li>
+</ul>
+
+</body>
+</html>
diff --git a/org.fortiss.tooling.common/html/developer/.ratings b/org.fortiss.tooling.common/html/developer/.ratings
index a3448c2c0..ca76f28c6 100644
--- a/org.fortiss.tooling.common/html/developer/.ratings
+++ b/org.fortiss.tooling.common/html/developer/.ratings
@@ -1 +1 @@
-documentation.html 2c826adbb9308780019449efc99310c62170dbfc RED
+documentation.html 30aeff34fe0feb7313c0e2b5c225206390652869 YELLOW
diff --git a/org.fortiss.tooling.common/html/developer/documentation.html b/org.fortiss.tooling.common/html/developer/documentation.html
index 2c826adbb..30aeff34f 100644
--- a/org.fortiss.tooling.common/html/developer/documentation.html
+++ b/org.fortiss.tooling.common/html/developer/documentation.html
@@ -1,4 +1,12 @@
-<html><body>
-<H1>Developer Documentation for <I>org.fortiss.tooling.common</I></H1>
-<P>// TODO
-</body></html>
+<html>
+<body>
+<h1>Developer Documentation for Tooling Common UI (<i>org.fortiss.tooling.common.ui</i>)</h1>
+
+This plugin bundles the following:
+<ul>
+<li>Non-UI (tooling) code that is independent of modeling or model-based development.</li>
+<li>External libraries that are shared between multiple plugins.</li>
+</ul>
+
+</body>
+</html>
-- 
GitLab