From 8fec3e5dbdfe362263d56d391d0b10950bfd663b Mon Sep 17 00:00:00 2001 From: Simon Barner <barner@fortiss.org> Date: Wed, 4 Jul 2018 15:09:34 +0200 Subject: [PATCH] Developer documentation of spider chart 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 | 20 +++++++++++++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/org.fortiss.tooling.spiderchart.ui/html/developer/.ratings b/org.fortiss.tooling.spiderchart.ui/html/developer/.ratings index de514d466..fbc42e310 100644 --- a/org.fortiss.tooling.spiderchart.ui/html/developer/.ratings +++ b/org.fortiss.tooling.spiderchart.ui/html/developer/.ratings @@ -1 +1 @@ -documentation.html 76dffdc2a7b31a074110e65d21ded439964639cd RED +documentation.html 986e2dea49f3e82df111a62b03fc52237f5593bd YELLOW diff --git a/org.fortiss.tooling.spiderchart.ui/html/developer/documentation.html b/org.fortiss.tooling.spiderchart.ui/html/developer/documentation.html index 76dffdc2a..986e2dea4 100644 --- a/org.fortiss.tooling.spiderchart.ui/html/developer/documentation.html +++ b/org.fortiss.tooling.spiderchart.ui/html/developer/documentation.html @@ -1,4 +1,16 @@ -<html><body> -<H1>Developer Documentation for <I>org.fortiss.tooling.spiderchart.ui</I></H1> -<P>// TODO -</body></html> +<html> +<body> +<h1>Developer Documentation for Tooling Spider Chart UI (<i>org.fortiss.tooling.spiderchart.ui</i>)</H1> +<p>This plugin provides a spider chart (also: radar chart) viewer (used to visualize multivariate data such as +Pareto optimal solutions).</p> +<p>It consists of the following packages: +<ul> +<li><code>model</code>: <code>SpiderChart</code> data model and support classes.</li> +<li><code>style</code>: Style definitions (axes, chart, colors, data series, fill, font, legend, lines).</li> +<li><code>util</code>: Utility methods.</li> +<li><code>widget</code>: <code>SpiderChartViewer</code> and support classes.</li> + +</ul> +</p> +</body> +</html> -- GitLab