From eacd96c5e9284582127bb2acfc09f7acdfb6fc40 Mon Sep 17 00:00:00 2001
From: Martin Pernollet <martin@jzy3d.org>
Date: Sun, 9 May 2021 13:21:46 +0200
Subject: [PATCH] clean

---
 jzy3d-core-awt/README.md                      |  7 ++++
 .../legends/colorbars/AWTColorbarLegend.java  |  9 +++--
 jzy3d-core-swt/README.md                      | 36 +------------------
 jzy3d-core/README.md                          |  2 ++
 4 files changed, 16 insertions(+), 38 deletions(-)

diff --git a/jzy3d-core-awt/README.md b/jzy3d-core-awt/README.md
index 5958f667..ab8fd2c1 100644
--- a/jzy3d-core-awt/README.md
+++ b/jzy3d-core-awt/README.md
@@ -1,6 +1,13 @@
 Jzy3d - Core AWT
 ================================
 
+Provides AWT components at the core level, meaning independent of JOGL or EmulGL.
+
+* Mouse and keyboard controllers implemented with AWT `MouseListener` and `KeyListener`)
+* Image rendering (based on AWT `BufferedImage`)
+* Overlays, tooltips, legends and colorbars rendering (based on AWT `Graphics2D`)
+* Conversions AWT<>Jzy3D (colors, fonts, etc)
+
 ## Javadoc schemas
 
 ### Colorbar
diff --git a/jzy3d-core-awt/src/main/java/org/jzy3d/plot3d/rendering/legends/colorbars/AWTColorbarLegend.java b/jzy3d-core-awt/src/main/java/org/jzy3d/plot3d/rendering/legends/colorbars/AWTColorbarLegend.java
index 99122606..9ced34c4 100644
--- a/jzy3d-core-awt/src/main/java/org/jzy3d/plot3d/rendering/legends/colorbars/AWTColorbarLegend.java
+++ b/jzy3d-core-awt/src/main/java/org/jzy3d/plot3d/rendering/legends/colorbars/AWTColorbarLegend.java
@@ -19,13 +19,15 @@ import org.jzy3d.plot3d.rendering.legends.AWTLegend;
 import org.jzy3d.plot3d.rendering.view.layout.ViewAndColorbarsLayout;
 
 /**
+ * Handle a colorbar rendered as an AWT {@link BufferedImage}.
+ * 
  * <h2>Content and coloring</h2>
  * 
- * A colorbar which is configured with
+ * A colorbar is configured with
  * <ul>
  * <li>a colormap defined by the input {@link Drawable} if it is {@link IMultiColorable} and if it
  * has a {@link ColorMapper} defined.
- * <li>a set of axis ticks defined by {@link IAxisLayout}
+ * <li>a set of axis ticks defined and formated by {@link IAxisLayout}.
  * </ul>
  * 
  * <h2>Layout</h2>
@@ -34,7 +36,7 @@ import org.jzy3d.plot3d.rendering.view.layout.ViewAndColorbarsLayout;
  * <ul>
  * <li>{@link #setViewPort(int, int, float, float)} which indicates the canvas dimension on screen
  * and the slice that the colorbar should occupy. The image width will be <code>imageWidth = width *
- * (right - left)<code>. The viewport is set by {@link ViewAndColorbarsLayout}.
+ * (right - left)</code>. The viewport is set by {@link ViewAndColorbarsLayout}.
  * </ul>
  * 
  * The position of the colorbar is defined by {@link ViewAndColorbarsLayout} which render the
@@ -42,6 +44,7 @@ import org.jzy3d.plot3d.rendering.view.layout.ViewAndColorbarsLayout;
  * parameters).
  * 
  * <img src="doc-files/colorbar-layout.png"/>
+ * <a href="https://lucid.app/lucidchart/78ec260b-d2d1-430d-a363-a95089dae86d/edit?page=F_rAt-Q~kI-~#">Schema sources</a>
  * 
  * <h2>Rendering path</h2>
  * 
diff --git a/jzy3d-core-swt/README.md b/jzy3d-core-swt/README.md
index 7d7815d0..19523d32 100644
--- a/jzy3d-core-swt/README.md
+++ b/jzy3d-core-swt/README.md
@@ -1,36 +1,2 @@
-Jzy3d - Core
+Jzy3d - Core SWT
 ================================
-
-Project layout
---------------
-Source folders organisation:
-- api holds the API sources
-- bridge holds classes to ease injection of components from a given windowing toolkit to another one (awt, swing, swt, newt)
-- tests holds
- - ChartTest, a tool to compare a chart with a previously saved screenshot
- - Replay, a utility to record and validate a sequence of mouse and key interactions results on a chart (work in progress)
-- awt and swing hold Windowing toolkit dependent classes.
- - Will be moved soon to external module as jzy3d-swt.
-
-Build files
---------------
-- Maven: pom.xml, with dependency on parent artifact <a href="https://github.com/jzy3d/jzy3d-api">jzy3d-master</a>
-- Eclipse: .project & .classpath files, generated by command "mvn eclipse:eclipse"
-- Ant: build.xml
-- Javadoc: javadoc.xml
-
-Library dependencies
---------------
-- <a href="http://jogamp.org/jogl/www/">jogl2</a>
-- <a href="https://github.com/jzy3d/jzy3d-api/tree/master/jzy3d-jdt-core">jdt</a> (Java Delaunay Triangulation)
-- opencsv
-- log4j
-- junit
-
-License
---------------
-New BSD
-
-More information
---------------
-http://www.jzy3d.org
diff --git a/jzy3d-core/README.md b/jzy3d-core/README.md
index 904b1948..7670be19 100644
--- a/jzy3d-core/README.md
+++ b/jzy3d-core/README.md
@@ -1,6 +1,8 @@
 Jzy3d - Core
 ================================
 
+Provides the base definition of charts without the rendering backend that may be implemented by JOGL (in all module named `jzy3d-native-jogl-*`) or EmulGL (in `jzy3d-emul-gl`).
+
 ## Javadoc schemas
 
 ### Camera