From e7b0b3ff2c6482280833d2bf296f5b027f6e1747 Mon Sep 17 00:00:00 2001
From: Christian Sarnataro <csarnataro@users.noreply.github.com>
Date: Thu, 19 Sep 2019 16:17:37 +0200
Subject: [PATCH] docs(data-point): add @class tags (#431)

- Replaced @alias tags with @class and @classdesc tags. Added DataPoint temporary favicon.
- Updated Docusaurus primary color to match jsdoc theme. Added a note for unstable version.

closes #422
---
 documentation/docs/getting-started.md          |   2 ++
 documentation/website/README.md                |   2 ++
 documentation/website/jsdoc.json               |  11 ++++++++++-
 documentation/website/siteConfig.js            |   2 +-
 documentation/website/static/img/favicon.ico   | Bin 766 -> 4286 bytes
 packages/data-point/src/Accumulator.js         |   2 +-
 packages/data-point/src/Cache.js               |   3 +++
 packages/data-point/src/DataPoint.js           |   4 ++++
 packages/data-point/src/Reducer.js             |   8 ++++----
 packages/data-point/src/ReducerEntity.js       |   4 ++++
 packages/data-point/src/ReducerFunction.js     |   4 ++++
 packages/data-point/src/ReducerList.js         |   4 ++++
 packages/data-point/src/ReducerNative.js       |   3 +++
 packages/data-point/src/ReducerObject.js       |   3 ++-
 packages/data-point/src/ReducerPath.js         |   3 ++-
 .../src/reducer-entities/model/model.js        |   4 ++++
 .../src/reducer-helpers/assign/assign.js       |   4 ++++
 .../src/reducer-helpers/constant/constant.js   |   4 ++++
 .../if-then-else/if-then-else.js               |   4 ++++
 .../data-point/src/reducer-helpers/map/map.js  |   2 ++
 .../src/reducer-helpers/parallel/parallel.js   |   4 ++++
 .../src/reducer-helpers/select/select.js       |   2 ++
 packages/data-point/src/tracing/Span.js        |   2 +-
 packages/data-point/src/tracing/Tracer.js      |   3 +++
 24 files changed, 74 insertions(+), 10 deletions(-)

diff --git a/documentation/docs/getting-started.md b/documentation/docs/getting-started.md
index 15d9a8c7..a463a0d5 100644
--- a/documentation/docs/getting-started.md
+++ b/documentation/docs/getting-started.md
@@ -4,6 +4,8 @@ title: Getting Started
 sidebar_label: Getting Started
 ---
 
+> ⚠️ WARNING: the version of DataPoint documented here is version 6.x-canary, it's an unstable version and as such it must not be considered production-ready
+
 **DataPoint is a JavaScript Utility for collecting, processing and transforming data.**
 
 DataPoint helps you reason with and streamline your data processing layer. With it you can collect, process, and transform data from multiple sources, and deliver the output in a tailored format to your end consumer.
diff --git a/documentation/website/README.md b/documentation/website/README.md
index fc706a81..89dfd969 100755
--- a/documentation/website/README.md
+++ b/documentation/website/README.md
@@ -1,5 +1,7 @@
 # DataPoint API reference
 
+> ⚠️ **WARNING**: the version of DataPoint documented here is version 6.x-canary, it's an unstable version and as such it must not be considered production-ready
+
 This is the API reference for [Datapoint](https://github.com/ViacomInc/data-point), a JavaScript Utility for collecting, processing and transforming data.
 
 You can explore the API using the menu on the left.
diff --git a/documentation/website/jsdoc.json b/documentation/website/jsdoc.json
index 15c92a08..41b9ddde 100644
--- a/documentation/website/jsdoc.json
+++ b/documentation/website/jsdoc.json
@@ -13,7 +13,6 @@
   "opts": {
     "template": "./node_modules/docdash",
     "encoding": "utf8",
-    "destination": "docs/",
     "recurse": true,
     "verbose": true
   },
@@ -25,6 +24,16 @@
     "static": true,
     "sort": true,
     "disqus": "",
+    "sectionOrder": [
+      "Tutorials",
+      "Classes",
+      "Modules",
+      "Externals",
+      "Events",
+      "Namespaces",
+      "Mixins",
+      "Interfaces"
+    ],
     "openGraph": {
       "title": "Docdash",
       "type": "website",
diff --git a/documentation/website/siteConfig.js b/documentation/website/siteConfig.js
index c662eec3..31613512 100644
--- a/documentation/website/siteConfig.js
+++ b/documentation/website/siteConfig.js
@@ -42,7 +42,7 @@ const siteConfig = {
 
   /* Colors for website */
   colors: {
-    primaryColor: "#250e23",
+    primaryColor: "#6d426d",
     secondaryColor: "#190918"
   },
 
diff --git a/documentation/website/static/img/favicon.ico b/documentation/website/static/img/favicon.ico
index be74abd69ad6a32de7375df13cab9354798e328f..d5705d10e30c2821aac8f0ecf24e367519ca1e03 100755
GIT binary patch
literal 4286
zcmcha3s96*6vsb6Bg@h#9%3p>fR^koC<==5SR#a29n{g(UX}#olrfrVX~mc#3Ig#;
zBWN>GL_ri#5G7<_Qiz9&$e<OC8a3s_jODBBbk6<u?)Qn`E^ArK{P%u)zkAQ`+{Zch
zA_zA4=jJBRw@@@(5S#=-7>B|tAp}MB_u`}3|Fz&#)iDe;6P1HHkLpHcp`uX_srNPA
z3ly_q^Qa5)>`+?N+o)R9H58c9RjfaPT8Yx2Z12_?ZDl(#9Z}Dr45*7JWnT3enACU)
zCLHZneqYsb0s9u9=Aj<bR<sT14z`O&-9(wQDb*u?+Sxy0TGuU@+Hnp1n=gZ3{rBK|
zxKnB)*&&;8137?g(yU^WT^XNzFbRE{(tZUdfAu3ws68+DWs4R3!hg+|`-0CjCq|ov
zR`6;6@b-$O_TWh%@$rW=T!NssE7JJ;@oA43ZPr-g8{_L_f4=tMDHvZ=4^N~Og3Igg
z!TkX`a9y#1*`)QKvAF>BbLT_&j#@<@CLjNa^V>CL&1PNjsXA?g>|Ww)4zz+tW)X}?
zSO*UTMS^hO5WtR-@VC13INN_SQa%H{UJnu3#fp6Y=3h9!*XPh_8*>gI*B*6)_+vjg
zAhG0J{w(LG8W?{@`VK{YKx-f8UnhnIz6-wpi})UyyBXhR=x`Vs9s?uZOa%AT?clb4
zo9Gwu_ni>Ozh%3~M?Xw4Alm~J3uM!1+t~u&+t?0N$pwt#9KRZH&Uk<D%qfxhWlbVK
zP2@)==PB~1p1x}8kM_MS@WVKN^aojt<GOskysv3qXg{d;Hyin1u<=K(%U0wEcHWfR
z2(!Rn#Q7uNN@Dy`Yt!X@F$Q+9dRiCFffkXE>rVSG>iu*@KE;SnwJ9eqw7^f`eCN1T
zj5FrLt+(;rQw(?VGYT0$ddV9QUfc+}nr;ZjTs-~E4U<2<HC^0Jf(3pO=Q}KjV;uLC
z&v`#qsy2Qq@*i;oO?j(0{*0ZBPjg_>tQd%XVF^U7P6l0dmpl(AS>V%I#W=L*u^o71
z72n3E`Jj4RM_15Pw2AzWc1c{h560(b4AtOwtcTmlx4^F?KIJ=mzv+zQwXKZzV<q30
zwl1SVThT7^Gev&%qQwxAR}PeqqE>H&=$GP{UlBQbVN%0IZl^+t?~$>K&i!V_FK+{~
zPvabCsN(%tIciOsIR23;z`KHxU&J`kvCG(Ro&!Q_zhU)}oAU82?B#Zv+&3HUZ~<eS
z_&vl|m!2@?+ouX^c|TS@zG^e$+l}^QXAsN(S-VC4i?PW6!?fo@8h>E*QEOAdzv*Xg
zr-xYmKggwf*6+k0zv~!dU>oq>)5!a=lJWu7+o{H~bs~NQ=P!I2rgcjE;HJxr|Ln4N
zA)w_~Zs#{*DexVz{uc3R&WS-Wt}bil{a86-St5Hk$Wtxxv-gPOpa1-AF&Bh+S5I+(
z`(TQ61`xwRf$v3ZlGoOK;uvv`DaI)OYAf-~$9>@xyOO;d{G=~vv7U`TN95~cW<&VS
zI(WLY3Bt<TA*|vg=x5Ib{hWCaDDjEmrN9s5d^+d(_#f6UfCqJYu%8qRgT`vvoY1?$
z<0mq|ME+hjepBrCkHML<U^?a_ZXe4)1^yiV-YqGQ@rh$jLjuE@J;u*1vCKz*LK<=Z
z<9*S{n4`d7%K4+#q?_e(e^i?aO!u#dk4p#Shkp4j_|}}|{G|%~M9x<w=Y!+o1aN$1
zIXJz#f~~pJYpa0HV(0jGz!mRAlzaI7FSP!GxZahgAnafV=nkF1oO>2@hr8HWpgVF7
zXfIAUdXDoG75KTFZ*^(z{w=$E@LWXY#JcY|KUaZYVl~$oCw%;JhNWk}h6|iuqQGzb
zCw$5)0WE!2X`*xnH7M}u|5)zde_eJf@caHpejn#U-!Q;ngX@AY1}lg4SC1gr-;L@7
I!R~JKH@>O%HUIzs

literal 766
zcmc(dze~eV5XUd2fg&jH87YDYDQKxq1{4b-_ydP-wqS9vgGh17QXQQAwOE{VaBvi*
zmu^z9t({y-&1ey<?*19x`_a%0;^>8Y_x;?x+`BviV9;aRjMgZ8M*!jgkRrFqSI9;F
zHyfX@Az|AvVmn~YWWZP`0&JWEY~BFm?*Vq}VD7&_%x%MP$p`D`4JMC!K|B7pt?Mmp
zUJAB7rxMXS6=!P+AtLU9V)J#61WPxwipRXCHO{BJ`l{m53#=t97a!znv~vfmr|AaP
zRGIT7#0FyJy3Z*hL{GQp-0TRhX8UzZ)+>%?mK0^goaX4Q;x<h|7I8a@t8#9Z`A~@1
zIx{#+`h7(7bA0+s7#-k=_?cTQZjqG{+al%<xj`*i0llsi@&x*V=JS=7GQ@hVV0w`-
td#$W2=*99o&LFePcYQf3%L?7WGUv;WVIDdObG#I0%L#Kp!H@7y;s@Y5ipBr{

diff --git a/packages/data-point/src/Accumulator.js b/packages/data-point/src/Accumulator.js
index 971ed66f..a78591b6 100644
--- a/packages/data-point/src/Accumulator.js
+++ b/packages/data-point/src/Accumulator.js
@@ -1,5 +1,5 @@
 /**
- * @alias Accumulator
+ * @class
  */
 class Accumulator {
   constructor(options = {}) {
diff --git a/packages/data-point/src/Cache.js b/packages/data-point/src/Cache.js
index 94175d32..567571d1 100644
--- a/packages/data-point/src/Cache.js
+++ b/packages/data-point/src/Cache.js
@@ -2,6 +2,9 @@ function isValidCacheMethod(callback) {
   return typeof callback === "function" || callback === undefined;
 }
 
+/**
+ * @class
+ */
 class Cache {
   constructor() {
     /**
diff --git a/packages/data-point/src/DataPoint.js b/packages/data-point/src/DataPoint.js
index 1346344a..3b7be134 100644
--- a/packages/data-point/src/DataPoint.js
+++ b/packages/data-point/src/DataPoint.js
@@ -77,6 +77,10 @@ function validateTracer(tracer) {
   }
 }
 
+/**
+ * @class
+ * @classdesc DataPoint main class
+ */
 class DataPoint {
   constructor() {
     Object.defineProperty(this, "cache", {
diff --git a/packages/data-point/src/Reducer.js b/packages/data-point/src/Reducer.js
index eed275a7..52c84f58 100644
--- a/packages/data-point/src/Reducer.js
+++ b/packages/data-point/src/Reducer.js
@@ -5,10 +5,11 @@ function normalizeName(name) {
 }
 
 /**
- * @alias Reducer
+ * @class
+ * @classdesc This class is never instantiated directly, it is used to create
+ * reducers DataPoint can use to process a given input.
+ *
  * @protected
- * This class is never instantiated directly, it is used to create reducers
- *  DataPoint can use to process a given input.
  */
 class Reducer {
   /**
@@ -19,7 +20,6 @@ class Reducer {
     /**
      * @type {string} Normalized reducer's id
      * @name Reducer#id
-     * @property
      * @readonly
      */
     Object.defineProperty(this, "id", {
diff --git a/packages/data-point/src/ReducerEntity.js b/packages/data-point/src/ReducerEntity.js
index 3b74f6e1..14b9fc0b 100644
--- a/packages/data-point/src/ReducerEntity.js
+++ b/packages/data-point/src/ReducerEntity.js
@@ -1,6 +1,10 @@
 const { createReducer } = require("./create-reducer");
 const { Reducer } = require("./Reducer");
 
+/**
+ * @class
+ * @extends Reducer
+ */
 class ReducerEntity extends Reducer {
   constructor(spec) {
     super(spec.name, spec);
diff --git a/packages/data-point/src/ReducerFunction.js b/packages/data-point/src/ReducerFunction.js
index b4c0d7d7..4d2b0c87 100644
--- a/packages/data-point/src/ReducerFunction.js
+++ b/packages/data-point/src/ReducerFunction.js
@@ -1,5 +1,9 @@
 const { Reducer } = require("./Reducer");
 
+/**
+ * @class
+ * @extends Reducer
+ */
 class ReducerFunction extends Reducer {
   constructor(spec) {
     super(spec.name || "anonymous", spec);
diff --git a/packages/data-point/src/ReducerList.js b/packages/data-point/src/ReducerList.js
index 3870c65d..297986ef 100644
--- a/packages/data-point/src/ReducerList.js
+++ b/packages/data-point/src/ReducerList.js
@@ -1,5 +1,9 @@
 const { Reducer } = require("./Reducer");
 
+/**
+ * @class
+ * @extends Reducer
+ */
 class ReducerList extends Reducer {
   constructor(spec, createReducer) {
     super(undefined, spec);
diff --git a/packages/data-point/src/ReducerNative.js b/packages/data-point/src/ReducerNative.js
index 8d62fa18..1e466d84 100644
--- a/packages/data-point/src/ReducerNative.js
+++ b/packages/data-point/src/ReducerNative.js
@@ -1,5 +1,8 @@
 const { Reducer } = require("./Reducer");
 
+/**
+ * @class
+ */
 class ReducerNative extends Reducer {
   static isType() {
     throw new Error("must be implemented");
diff --git a/packages/data-point/src/ReducerObject.js b/packages/data-point/src/ReducerObject.js
index d647be68..363af0af 100644
--- a/packages/data-point/src/ReducerObject.js
+++ b/packages/data-point/src/ReducerObject.js
@@ -50,7 +50,8 @@ function getObjectProperties(
 }
 
 /**
- * **IMPORTANT:** This class is meant to be only called internally by DataPoint.
+ * @class
+ * @classdesc **IMPORTANT:** This class is meant to be only called internally by DataPoint.
  * @protected
  * @extends {Reducer}
  */
diff --git a/packages/data-point/src/ReducerPath.js b/packages/data-point/src/ReducerPath.js
index a83a0919..af7309db 100644
--- a/packages/data-point/src/ReducerPath.js
+++ b/packages/data-point/src/ReducerPath.js
@@ -124,7 +124,8 @@ function resolvePath(accumulator, compiledPath) {
 }
 
 /**
- * Reducer that crawls a data path (using dot notation) from the accumulator
+ * @class
+ * @classdesc Reducer that crawls a data path (using dot notation) from the accumulator
  * @extends {Reducer}
  */
 class ReducerPath extends Reducer {
diff --git a/packages/data-point/src/reducer-entities/model/model.js b/packages/data-point/src/reducer-entities/model/model.js
index 480d11be..e9a89e73 100644
--- a/packages/data-point/src/reducer-entities/model/model.js
+++ b/packages/data-point/src/reducer-entities/model/model.js
@@ -1,5 +1,9 @@
 const { ReducerEntity } = require("../../ReducerEntity");
 
+/**
+ * @class
+ * @extends ReducerEntity
+ */
 class ReducerModel extends ReducerEntity {
   static create(spec) {
     return new ReducerModel(spec);
diff --git a/packages/data-point/src/reducer-helpers/assign/assign.js b/packages/data-point/src/reducer-helpers/assign/assign.js
index 2dc0f6b3..a88ed448 100644
--- a/packages/data-point/src/reducer-helpers/assign/assign.js
+++ b/packages/data-point/src/reducer-helpers/assign/assign.js
@@ -1,6 +1,10 @@
 const { Reducer } = require("../../Reducer");
 const { createReducer } = require("../../create-reducer");
 
+/**
+ * @class
+ * @extends Reducer
+ */
 class ReducerAssign extends Reducer {
   constructor(spec) {
     super(undefined, spec);
diff --git a/packages/data-point/src/reducer-helpers/constant/constant.js b/packages/data-point/src/reducer-helpers/constant/constant.js
index dc649c6c..0e591542 100644
--- a/packages/data-point/src/reducer-helpers/constant/constant.js
+++ b/packages/data-point/src/reducer-helpers/constant/constant.js
@@ -12,6 +12,10 @@ function cloneObject(isObject, value) {
   return isObject ? cloneDeep(value) : value;
 }
 
+/**
+ * @class
+ * @extends Reducer
+ */
 class ReducerConstant extends Reducer {
   constructor(spec) {
     super(undefined, spec);
diff --git a/packages/data-point/src/reducer-helpers/if-then-else/if-then-else.js b/packages/data-point/src/reducer-helpers/if-then-else/if-then-else.js
index 4e647124..99885032 100644
--- a/packages/data-point/src/reducer-helpers/if-then-else/if-then-else.js
+++ b/packages/data-point/src/reducer-helpers/if-then-else/if-then-else.js
@@ -16,6 +16,10 @@ function parseIfElse(spec) {
   };
 }
 
+/**
+ * @class
+ * @extends Reducer
+ */
 class ReducerIfThenElse extends Reducer {
   constructor(spec) {
     super(undefined, spec);
diff --git a/packages/data-point/src/reducer-helpers/map/map.js b/packages/data-point/src/reducer-helpers/map/map.js
index d72efd84..4538d196 100644
--- a/packages/data-point/src/reducer-helpers/map/map.js
+++ b/packages/data-point/src/reducer-helpers/map/map.js
@@ -2,6 +2,8 @@ const { Reducer } = require("../../Reducer");
 const { createReducer } = require("../../create-reducer");
 
 /**
+ * @class
+ * @classdesc
  * Creates an array of values by running each element in collection thru
  * iterateeReducer.
  *
diff --git a/packages/data-point/src/reducer-helpers/parallel/parallel.js b/packages/data-point/src/reducer-helpers/parallel/parallel.js
index 156b466b..16f2ada6 100644
--- a/packages/data-point/src/reducer-helpers/parallel/parallel.js
+++ b/packages/data-point/src/reducer-helpers/parallel/parallel.js
@@ -2,7 +2,11 @@ const { Reducer } = require("../../Reducer");
 const { createReducer } = require("../../create-reducer");
 
 /**
+ * @class
+ * @classdesc
  * Runs in parallel a set of provided reducers against the provided input.
+ *
+ * @extends Reducer
  */
 class ReducerParallel extends Reducer {
   constructor(spec) {
diff --git a/packages/data-point/src/reducer-helpers/select/select.js b/packages/data-point/src/reducer-helpers/select/select.js
index 7659cb69..500d5718 100644
--- a/packages/data-point/src/reducer-helpers/select/select.js
+++ b/packages/data-point/src/reducer-helpers/select/select.js
@@ -100,6 +100,8 @@ async function getMatchingCaseStatement(caseStatements, acc, resolveReducer) {
 }
 
 /**
+ * @class
+ * @classdesc
  * Mirrors a simplified behaviour of the `switch` statement in javascript.
  * It creates a reducer which accepts the form of:
  *
diff --git a/packages/data-point/src/tracing/Span.js b/packages/data-point/src/tracing/Span.js
index d8db8939..73741833 100644
--- a/packages/data-point/src/tracing/Span.js
+++ b/packages/data-point/src/tracing/Span.js
@@ -7,7 +7,7 @@ function getHighResolutionTime() {
 }
 
 /**
- * @alias Span
+ * @class
  */
 class Span {
   constructor(name, options, tracer) {
diff --git a/packages/data-point/src/tracing/Tracer.js b/packages/data-point/src/tracing/Tracer.js
index 2418c7b3..bed3ac92 100644
--- a/packages/data-point/src/tracing/Tracer.js
+++ b/packages/data-point/src/tracing/Tracer.js
@@ -1,5 +1,8 @@
 const { Span } = require("./Span");
 
+/**
+ * @class
+ */
 class Tracer {
   constructor(handlers) {
     this.handlers = handlers;