Merge pull request #44 from ryonakano/update-docs

Update docs & docs generation
lcallarec · Jan 7, 2024 · f1ba79f · f1ba79f
2 parents 41e5803 + 2b9d5b8
commit f1ba79f
Show file tree

Hide file tree

Showing 358 changed files with 16,683 additions and 574 deletions.
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -25,12 +25,13 @@
 - [API](#api)
 - [Chart widget](#chart-widget)
 - [Series](#series)
-- [Serie renderer](#serie-renderers)
+- [Serie renderers](#serie-renderers)
 - [Chart configuration](#chart-configuration)
 - [Background](#background)
 - [Legend](#legend)
 - [Chart element visibility](#chart-element-visibility)
 - [Advanced usages](#advanced-usages)
+- [CAUTIONS](#cautions)
 - [How Livechart versions works ?](#how-livechart-versions-works)
 
     *N.B.: Classes and methods available in the source code and not documented here - even if they are public - are subject to change without warning in any future release*
@@ -76,7 +77,7 @@ ninja -C build
 var chart = LiveChart.Chart();
 ```
 
-As `Chart` object derives from `Gtk.DrawingArea`, you can directly attach it to any `Gtk.Container` :
+As `Chart` object derives from `Gtk.DrawingArea`, you can directly attach it to any container widgets :
 
 ```vala
 var window = new Gtk.Window();
@@ -135,7 +136,7 @@ Accessing a serie can be done via :
 
 Please note that your `Serie` must have been registered to the `Chart` before being able to add data points to this serie.
 
-Adding a point / value to a serie using [serie.add]((https://lcallarec.github.io/live-chart/Livechart/LiveChart.Serie.add.html) method automatically compute a timestamp stored in underlying value container.
+Adding a point / value to a serie using [serie.add](https://lcallarec.github.io/live-chart/Livechart/LiveChart.Serie.add.html) method automatically compute a timestamp stored in underlying value container.
 If you need to manually compute a timestamp, in milliseconds, use [serie.add_with_timestamp(double value, int64 timestamp)](https://lcallarec.github.io/live-chart/Livechart/LiveChart.Serie.add_with_timestamp.html)
 
 ```vala
@@ -169,7 +170,7 @@ serie.line.dash = Dash() {dashes = {1}, offset = 2};
 serie.line.visibility = false;//or true
 ```
 
-About color : [`Gdk.RGBA`](https://valadoc.org/gtk4/Gdk.RGBA.html) struct.
+About color : [`Gdk.RGBA`](https://valadoc.org/gtk4/Gdk.RGBA.html) struct.  
 Dashes : please refer to [valadoc](https://valadoc.org/cairo/Cairo.Context.set_dash.html) and [cairo c documentation](https://www.cairographics.org/manual/cairo-cairo-t.html#cairo-set-dash)
 
 For series with area, this impact only the outline, not the area itself.

diff --git a/docs/Livechart/LiveChart.Area.html b/docs/Livechart/LiveChart.Area.html
@@ -40,8 +40,8 @@ <h2 class="main_title">Object Hierarchy:</h2>
         <img class="main_diagram" usemap="#LiveChart.Area" alt="Object hierarchy for Area" src="img/LiveChart.Area.png"/>
 
       <map id="LiveChart.Area" name="LiveChart.Area">
-<area shape="rect" id="node1" href="LiveChart.Area.html" title="LiveChart.Area" alt="" coords="77,101,213,149"/>
-<area shape="rect" id="node3" href="LiveChart.Drawable.html" title="LiveChart.Drawable" alt="" coords="143,5,314,53"/>
+<area shape="rect" id="node1" href="LiveChart.Area.html" title="LiveChart.Area" alt="" coords="77,101,212,149"/>
+<area shape="rect" id="node3" href="LiveChart.Drawable.html" title="LiveChart.Drawable" alt="" coords="142,5,312,53"/>
 </map>
 
         <h2 class="main_title">Description:</h2>

diff --git a/docs/Livechart/LiveChart.Background.html b/docs/Livechart/LiveChart.Background.html
@@ -42,8 +42,8 @@ <h2 class="main_title">Object Hierarchy:</h2>
         <img class="main_diagram" usemap="#LiveChart.Background" alt="Object hierarchy for Background" src="img/LiveChart.Background.png"/>
 
       <map id="LiveChart.Background" name="LiveChart.Background">
-<area shape="rect" id="node1" href="LiveChart.Background.html" title="LiveChart.Background" alt="" coords="49,101,240,149"/>
-<area shape="rect" id="node3" href="LiveChart.Drawable.html" title="LiveChart.Drawable" alt="" coords="143,5,314,53"/>
+<area shape="rect" id="node1" href="LiveChart.Background.html" title="LiveChart.Background" alt="" coords="50,101,239,149"/>
+<area shape="rect" id="node3" href="LiveChart.Drawable.html" title="LiveChart.Drawable" alt="" coords="142,5,312,53"/>
 </map>
 
         <h2 class="main_title">Description:</h2>

diff --git a/docs/Livechart/LiveChart.Bar.html b/docs/Livechart/LiveChart.Bar.html
@@ -38,9 +38,9 @@ <h2 class="main_title">Object Hierarchy:</h2>
         <img class="main_diagram" usemap="#LiveChart.Bar" alt="Object hierarchy for Bar" src="img/LiveChart.Bar.png"/>
 
       <map id="LiveChart.Bar" name="LiveChart.Bar">
-<area shape="rect" id="node1" href="LiveChart.Bar.html" title="LiveChart.Bar" alt="" coords="81,197,208,245"/>
-<area shape="rect" id="node2" href="LiveChart.SerieRenderer.html" title="LiveChart.SerieRenderer" alt="" coords="42,101,247,149"/>
-<area shape="rect" id="node4" href="LiveChart.Drawable.html" title="LiveChart.Drawable" alt="" coords="143,5,314,53"/>
+<area shape="rect" id="node1" href="LiveChart.Bar.html" title="LiveChart.Bar" alt="" coords="81,197,207,245"/>
+<area shape="rect" id="node2" href="LiveChart.SerieRenderer.html" title="LiveChart.SerieRenderer" alt="" coords="42,101,246,149"/>
+<area shape="rect" id="node4" href="LiveChart.Drawable.html" title="LiveChart.Drawable" alt="" coords="142,5,312,53"/>
 </map>
 
         <h2 class="main_title">Description:</h2>

diff --git a/docs/Livechart/LiveChart.BezierCurve.c0.html b/docs/Livechart/LiveChart.BezierCurve.c0.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8"/>
+    <title>LiveChart.BezierCurve.c0 &ndash; Livechart &ndash; Vala Binding Reference</title>
+    <link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
+    </script>
+  </head>
+  <body>
+    <div class="site_header">LiveChart.BezierCurve.c0 &ndash; Livechart Reference Manual</div>
+    <div class="site_body">
+      <div class="site_navigation">
+        <ul class="navi_main">
+          <li class="package_index"><a href="../index.html">Packages</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="package"><a href="index.htm">Livechart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="namespace"><a href="LiveChart.html">LiveChart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="struct"><a href="LiveChart.BezierCurve.html">BezierCurve</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="field">c0</li>
+          <li class="field"><a href="LiveChart.BezierCurve.c1.html">c1</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c2.html">c2</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c3.html">c3</a></li>
+        </ul>
+      </div>
+      <div class="site_content">
+        <h1 class="main_title">c0</h1>
+        <hr class="main_hr"/>
+        <h2 class="main_title">Description:</h2>
+        <div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><span class="field">c0</span></b>
+        </div>
+      </div>
+    </div><br/>
+    <div class="site_footer">Generated by <a href="https://wiki.gnome.org/Projects/Valadoc"><kbd>valadoc</kbd></a>
+    </div>
+  </body>
+</html>
diff --git a/docs/Livechart/LiveChart.BezierCurve.c1.html b/docs/Livechart/LiveChart.BezierCurve.c1.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8"/>
+    <title>LiveChart.BezierCurve.c1 &ndash; Livechart &ndash; Vala Binding Reference</title>
+    <link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
+    </script>
+  </head>
+  <body>
+    <div class="site_header">LiveChart.BezierCurve.c1 &ndash; Livechart Reference Manual</div>
+    <div class="site_body">
+      <div class="site_navigation">
+        <ul class="navi_main">
+          <li class="package_index"><a href="../index.html">Packages</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="package"><a href="index.htm">Livechart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="namespace"><a href="LiveChart.html">LiveChart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="struct"><a href="LiveChart.BezierCurve.html">BezierCurve</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="field"><a href="LiveChart.BezierCurve.c0.html">c0</a></li>
+          <li class="field">c1</li>
+          <li class="field"><a href="LiveChart.BezierCurve.c2.html">c2</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c3.html">c3</a></li>
+        </ul>
+      </div>
+      <div class="site_content">
+        <h1 class="main_title">c1</h1>
+        <hr class="main_hr"/>
+        <h2 class="main_title">Description:</h2>
+        <div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><span class="field">c1</span></b>
+        </div>
+      </div>
+    </div><br/>
+    <div class="site_footer">Generated by <a href="https://wiki.gnome.org/Projects/Valadoc"><kbd>valadoc</kbd></a>
+    </div>
+  </body>
+</html>
diff --git a/docs/Livechart/LiveChart.BezierCurve.c2.html b/docs/Livechart/LiveChart.BezierCurve.c2.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8"/>
+    <title>LiveChart.BezierCurve.c2 &ndash; Livechart &ndash; Vala Binding Reference</title>
+    <link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
+    </script>
+  </head>
+  <body>
+    <div class="site_header">LiveChart.BezierCurve.c2 &ndash; Livechart Reference Manual</div>
+    <div class="site_body">
+      <div class="site_navigation">
+        <ul class="navi_main">
+          <li class="package_index"><a href="../index.html">Packages</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="package"><a href="index.htm">Livechart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="namespace"><a href="LiveChart.html">LiveChart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="struct"><a href="LiveChart.BezierCurve.html">BezierCurve</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="field"><a href="LiveChart.BezierCurve.c0.html">c0</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c1.html">c1</a></li>
+          <li class="field">c2</li>
+          <li class="field"><a href="LiveChart.BezierCurve.c3.html">c3</a></li>
+        </ul>
+      </div>
+      <div class="site_content">
+        <h1 class="main_title">c2</h1>
+        <hr class="main_hr"/>
+        <h2 class="main_title">Description:</h2>
+        <div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><span class="field">c2</span></b>
+        </div>
+      </div>
+    </div><br/>
+    <div class="site_footer">Generated by <a href="https://wiki.gnome.org/Projects/Valadoc"><kbd>valadoc</kbd></a>
+    </div>
+  </body>
+</html>
diff --git a/docs/Livechart/LiveChart.BezierCurve.c3.html b/docs/Livechart/LiveChart.BezierCurve.c3.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8"/>
+    <title>LiveChart.BezierCurve.c3 &ndash; Livechart &ndash; Vala Binding Reference</title>
+    <link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
+    </script>
+  </head>
+  <body>
+    <div class="site_header">LiveChart.BezierCurve.c3 &ndash; Livechart Reference Manual</div>
+    <div class="site_body">
+      <div class="site_navigation">
+        <ul class="navi_main">
+          <li class="package_index"><a href="../index.html">Packages</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="package"><a href="index.htm">Livechart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="namespace"><a href="LiveChart.html">LiveChart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="struct"><a href="LiveChart.BezierCurve.html">BezierCurve</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="field"><a href="LiveChart.BezierCurve.c0.html">c0</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c1.html">c1</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c2.html">c2</a></li>
+          <li class="field">c3</li>
+        </ul>
+      </div>
+      <div class="site_content">
+        <h1 class="main_title">c3</h1>
+        <hr class="main_hr"/>
+        <h2 class="main_title">Description:</h2>
+        <div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><span class="field">c3</span></b>
+        </div>
+      </div>
+    </div><br/>
+    <div class="site_footer">Generated by <a href="https://wiki.gnome.org/Projects/Valadoc"><kbd>valadoc</kbd></a>
+    </div>
+  </body>
+</html>
diff --git a/docs/Livechart/LiveChart.BezierCurve.html b/docs/Livechart/LiveChart.BezierCurve.html
@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8"/>
+    <title>LiveChart.BezierCurve &ndash; Livechart &ndash; Vala Binding Reference</title>
+    <link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
+    </script>
+  </head>
+  <body>
+    <div class="site_header">LiveChart.BezierCurve &ndash; Livechart Reference Manual</div>
+    <div class="site_body">
+      <div class="site_navigation">
+        <ul class="navi_main">
+          <li class="package_index"><a href="../index.html">Packages</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="package"><a href="index.htm">Livechart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="namespace"><a href="LiveChart.html">LiveChart</a></li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="struct">BezierCurve</li>
+        </ul>
+        <hr class="navi_hr"/>
+        <ul class="navi_main">
+          <li class="field"><a href="LiveChart.BezierCurve.c0.html">c0</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c1.html">c1</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c2.html">c2</a></li>
+          <li class="field"><a href="LiveChart.BezierCurve.c3.html">c3</a></li>
+        </ul>
+      </div>
+      <div class="site_content">
+        <h1 class="main_title">BezierCurve</h1>
+        <hr class="main_hr"/>
+        <h2 class="main_title">Object Hierarchy:</h2>
+        <img class="main_diagram" usemap="#LiveChart.BezierCurve" alt="Object hierarchy for BezierCurve" src="img/LiveChart.BezierCurve.png"/>
+
+      <map id="LiveChart.BezierCurve" name="LiveChart.BezierCurve">
+<area shape="rect" id="node1" href="LiveChart.BezierCurve.html" title="LiveChart.BezierCurve" alt="" coords="5,5,198,53"/>
+</map>
+
+        <h2 class="main_title">Description:</h2>
+        <div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">struct</span> <b><span class="struct">BezierCurve</span></b>
+        </div><br/>
+        <div class="namespace_note"><b>Namespace:</b> <a href="LiveChart.html">LiveChart</a>
+        </div>
+        <div class="package_note"><b>Package:</b> <a href="index.htm">Livechart</a>
+        </div>
+        <h2 class="main_title">Content:</h2>
+        <h3 class="main_title">Fields:</h3>
+        <ul class="navi_inline">
+          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><a href="LiveChart.BezierCurve.c0.html" class="field">c0</a></b>
+            </span>
+            <div class="leaf_brief_description">
+            </div></li>
+          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><a href="LiveChart.BezierCurve.c1.html" class="field">c1</a></b>
+            </span>
+            <div class="leaf_brief_description">
+            </div></li>
+          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><a href="LiveChart.BezierCurve.c2.html" class="field">c2</a></b>
+            </span>
+            <div class="leaf_brief_description">
+            </div></li>
+          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="LiveChart.Coord.html" class="struct">Coord</a></span> <b><a href="LiveChart.BezierCurve.c3.html" class="field">c3</a></b>
+            </span>
+            <div class="leaf_brief_description">
+            </div></li>
+        </ul>
+      </div>
+    </div><br/>
+    <div class="site_footer">Generated by <a href="https://wiki.gnome.org/Projects/Valadoc"><kbd>valadoc</kbd></a>
+    </div>
+  </body>
+</html>