From 59f8350394f95f31b9e46ee8be1eed6047caa0bb Mon Sep 17 00:00:00 2001
From: luca-vercelli <luca.vercelli.to@gmail.com>
Date: Tue, 18 Jan 2022 10:45:09 +0100
Subject: [PATCH] Some comments on code

I documented some functions in the code, so that it can be easier to read
---
 src/index.js | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/src/index.js b/src/index.js
index 68b6af1d2..0ed583941 100644
--- a/src/index.js
+++ b/src/index.js
@@ -91,6 +91,10 @@ export default class Gantt {
         this.options = Object.assign({}, default_options, options);
     }
 
+    /**
+     * Set x._start, x._end, x._index for each task
+     * May set x.id, x.invalid, x.dependencies
+     */
     setup_tasks(tasks) {
         // prepare tasks
         this.tasks = tasks.map((task, i) => {
@@ -156,6 +160,9 @@ export default class Gantt {
         this.setup_dependencies();
     }
 
+    /**
+     * Set this.dependency_map
+     */
     setup_dependencies() {
         this.dependency_map = {};
         for (let t of this.tasks) {
@@ -179,6 +186,10 @@ export default class Gantt {
         this.trigger_event('view_change', [mode]);
     }
 
+    /**
+     * Set this.options.view_mode, this.options.step and this.options.column_width
+     * according to view_mode
+     */
     update_view_scale(view_mode) {
         this.options.view_mode = view_mode;
 
@@ -208,6 +219,9 @@ export default class Gantt {
         this.setup_date_values();
     }
 
+    /**
+     * Set this.gantt_start and this.gantt_end
+     */
     setup_gantt_dates() {
         this.gantt_start = this.gantt_end = null;
 
@@ -240,6 +254,9 @@ export default class Gantt {
         }
     }
 
+    /**
+     * Set this.dates
+     */
     setup_date_values() {
         this.dates = [];
         let cur_date = null;
@@ -439,6 +456,9 @@ export default class Gantt {
         }
     }
 
+    /**
+     * Render month names, day numbers, hours on diagram
+     */
     make_dates() {
         for (let date of this.get_dates_to_draw()) {
             createSVG('text', {
@@ -562,6 +582,9 @@ export default class Gantt {
         };
     }
 
+    /**
+     * Render task bars on diagram
+     */
     make_bars() {
         this.bars = this.tasks.map(task => {
             const bar = new Bar(this, task);
@@ -570,6 +593,9 @@ export default class Gantt {
         });
     }
 
+    /**
+     * Render dependency arrows on diagram
+     */
     make_arrows() {
         this.arrows = [];
         for (let task of this.tasks) {
@@ -602,6 +628,9 @@ export default class Gantt {
         }
     }
 
+    /**
+     * Set svg rect. Scrollbars will appear.
+     */
     set_width() {
         const cur_width = this.$svg.getBoundingClientRect().width;
         const actual_width = this.$svg