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
ViacomInc · Sep 19, 2019 · e7b0b3f · e7b0b3f
1 parent c85c526
commit e7b0b3f
Show file tree

Hide file tree

Showing 24 changed files with 74 additions and 10 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,5 +1,8 @@
 const { Span } = require("./Span");
 
+/**
+ * @class
+ */
 class Tracer {
   constructor(handlers) {
     this.handlers = handlers;