docs: Enhance API Reference - Documentation improvements (#410)

benchmark/__tests__/util.js

@@ -1,3 +1,5 @@
+// Functions consumed by the benchmark contracts tests
+
 export function formatGas(gas) {
   if (gas < 10 ** 12) {
     let tGas = gas / 10 ** 12;

benchmark/src/deploy-contract.js

@@ -1,5 +1,10 @@
 import { near } from "near-sdk-js";
 
+/**
+ * Used for contract deployment. More information for that
+ * can be found in the README.md
+ * - Deploy and cross contract call
+ */
 export function deploy_contract() {
   let promiseId = near.promiseBatchCreate("a.caller.test.near");
   near.promiseBatchActionCreateAccount(promiseId);

benchmark/src/expensive-calc.js

@@ -1,5 +1,10 @@
 import { NearBindgen, call, near } from "near-sdk-js";
 
+/**
+ * ExpensiveCalc is connected to the expensive contract. More information for that
+ * can be found in the README.md
+ * - Computational expensive contract
+ */
 @NearBindgen({})
 export class ExpensiveCalc {
   @call({})

benchmark/src/highlevel-collection.js

@@ -1,5 +1,9 @@
 import { NearBindgen, call, UnorderedMap } from "near-sdk-js";
 
+/**
+ * More information for that can be found in the README.md
+ * - Highlevel collection
+ */
 @NearBindgen({})
 export class HighlevelCollection {
   constructor() {

benchmark/src/highlevel-minimal.js

@@ -1,5 +1,9 @@
 import { NearBindgen, call } from "near-sdk-js";
 
+/**
+ * More information for that can be found in the README.md
+ * - A highlevel minimal contract (using nearbindgen)
+ */
 @NearBindgen({})
 export class HighlevelMinimal {
   @call({})

benchmark/src/lowlevel-api.js

@@ -1,10 +1,18 @@
 import { near } from "near-sdk-js";
 
+/**
+ * Helper method for the low level api. More information for that can be found in the README.md
+ * - Low level API
+ */
 export function lowlevel_storage_write() {
   let data = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
   near.storageWriteRaw(data, data);
 }
 
+/**
+ * Helper method for the low level api. More information for that can be found in the README.md
+ * - Low level API
+ */
 export function lowlevel_storage_write_many() {
   let data = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
   near.storageWriteRaw(data, data);

benchmark/src/lowlevel-minimal.js

@@ -1,3 +1,7 @@
 import { near } from "near-sdk-js";
 
+/**
+ * More information for that can be found in the README.md
+ * - A minimal contract
+ */
 export function empty() {}