From 786529d11a84070d8b76e566f8edadfe35744462 Mon Sep 17 00:00:00 2001
From: hppeng <hppeng>
Date: Fri, 29 Jul 2022 11:22:39 -0700
Subject: [PATCH] More top of file comments

---
 js/atree.js |  5 +++++
 js/build.js | 21 +++++++++------------
 2 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/js/atree.js b/js/atree.js
index cd02ea2..ecdbb99 100644
--- a/js/atree.js
+++ b/js/atree.js
@@ -1,3 +1,8 @@
+/** 
+ * This file defines computation graph nodes and display code relevant to the ability tree.
+ * TODO: possibly split it up into compute and render... but its a bit complicated :/
+ */
+
 /**
 ATreeNode spec:
 
diff --git a/js/build.js b/js/build.js
index 6211e43..59d7d40 100644
--- a/js/build.js
+++ b/js/build.js
@@ -1,4 +1,9 @@
-
+/** 
+ * This file defines a class representing the player Build.
+ *
+ * Keeps track of equipment list, equip order, skillpoint assignment (initial),
+ * Aggregates item stats into a statMap to be used in damage calculation.
+ */
 
 const classDefenseMultipliers = new Map([ ["relik",0.50], ["bow",0.60], ["wand", 0.80], ["dagger", 1.0], ["spear",1.0], ["sword", 1.10]]);
 
@@ -10,15 +15,9 @@ class Build{
     /**
      * @description Construct a build.
      * @param {Number} level : Level of the player.
-     * @param {String[]} equipment : List of equipment names that make up the build.
-     *                    In order: boots, Chestplate, Leggings, Boots, Ring1, Ring2, Brace, Neck, Weapon.
-     * @param {Number[]} powders : Powder application. List of lists of integers (powder IDs).
-     *                  In order: boots, Chestplate, Leggings, Boots, Weapon.
-     * @param {Object[]} inputerrors : List of instances of error-like classes.
-     * 
-     * @param {Object[]} tomes: List of tomes.
-     *                      In order: 2x Weapon Mastery Tome, 4x Armor Mastery Tome, 1x Guild Tome.
-     *                      2x Slaying Mastery Tome, 2x Dungeoneering Mastery Tome, 2x Gathering Mastery Tome are in game, but do not have "useful" stats (those that affect damage calculations or building)
+     * @param {String[]} items: List of equipment names that make up the build.
+     *                    In order: Helmet, Chestplate, Leggings, Boots, Ring1, Ring2, Brace, Neck, Tomes [x7].
+     * @param {Item} weapon: Weapon that this build is using.
      */
     constructor(level, items, weapon){
 
@@ -39,7 +38,6 @@ class Build{
         this.equipment = items;
         this.weapon = weapon;
         this.items = this.equipment.concat([this.weapon]);
-        // return [equip_order, best_skillpoints, final_skillpoints, best_total];
 
         // calc skillpoints requires statmaps only
         let result = calculate_skillpoints(this.equipment.map((x) => x.statMap), this.weapon.statMap);
@@ -61,7 +59,6 @@ class Build{
         return [this.equipment,this.weapon].flat();
     }
 
-
     /*  Get all stats for this build. Stores in this.statMap.
         @pre The build itself should be valid. No checking of validity of pieces is done here.
     */