doc

Author: roguib

src/generator.ts

@@ -3,6 +3,12 @@ import logger from "./shared/logger";
 const fs = require("fs");
 const path = require("path");
 
+/**
+ *
+ * @param {Array<File>} files An array of tokens generated after parsing the content of every file
+ * @param {string} outputPath The location in which the function has to write the file with the deffinitions
+ * of the snippets
+ */
 export const generator = (files: Array<File>, outputPath: string): void => {
   // scope will be html only for now
   let json = Object();

src/parser.ts

@@ -9,6 +9,11 @@ import pathResolver from "./utils/path-resolver";
 import { REGEX_SELECTORS } from "./utils/regexSelectors";
 
 // TODO: Test in other OS (github actions)
+/**
+ *
+ * @param {IFIleData} data An array of files that can contain component or class definitions
+ * @returns {File} An array filed of tokens that contains information about each component parsed
+ */
 export const parser = (data: Array<IFileData>): Array<File> => {
   let result: Array<File> = [],
     tmp: Array<Partial<File>> = []; // a temporal variable used for storing @Inputs/@Outputs declared on a parent class