Merge pull request #25 from thom-cr/function_parsing

Last modifications and implementation of Function Parsing

Author: thom-cr

src/functions/DocumentationGenerator.js

@@ -1,20 +1,21 @@
 const FileParsing = require('./FileParsing');
-const OutputTitle = require('./OutputTitle');
+const OutputTitlePDF = require('./OutputTitlePDF');
 const OutputNameFilePDF = require('./OutputNameFilePDF');
 const WritePDF = require('./WritePDF');
 const OutputTitleMarkdown = require('./OutputTitleMarkdown');
 const OutputNameFileMarkdown = require('./OutputNameFileMarkdown');
 const WriteMarkdown = require('./WriteMarkdown');
+
 /* Doc: 
-    explication du generateur de documentation
-    qui est vraiment super genial
+    Function called by DocumentationGenerator component to generate output file (PDF and/or MD) with the help of
+    WritePDF and WriteMarkdown
 */
 const DocumentationGenerator = async (formData, rows) => {
     const { projectName, formats } = formData;
     const filesParsed = await FileParsing(formData, rows);
 
     if (formats.pdf) {
-        const outputTitle = OutputTitle(projectName);
+        const outputTitle = OutputTitlePDF(projectName);
         const outputNameFilePDF = OutputNameFilePDF(projectName);
 
         WritePDF(outputTitle, outputNameFilePDF, filesParsed);

src/functions/FileParsing.js

@@ -1,3 +1,5 @@
+// Doc: Used to parse files and only keep the ones with desired extensions
+
 const FileParsing = async (formData, rows) => {
     if (!formData || !formData.files || !Array.isArray(rows)) {
         return [];

src/functions/FilesArray.js

@@ -1,7 +1,7 @@
 const ToArrayExtensions = require("./ToArrayExtensions");
 const FilterFiles = require("./FilterFiles");
 
-// Doc: fonction permettant l'affichage des fichiers pris en charge par la generation de la documentation
+// Doc: Use to display the files selected by FileSelector or FolderSelector. It updates based on the extensions input.
 async function FilesArray (files, extensionsName) {
     if (!extensionsName || typeof extensionsName !== "string" || extensionsName.trim().length === 0) {
         return []; 

src/functions/FilesArraySelection.js

@@ -1,4 +1,4 @@
-//doc: fonction qui retourne un dictionnaire avec le nom du fichier et l'extension
+//doc: returns dictionnary with fileName and extensions
 
 const FilesArraySelection = (files) => {
     const rows = files.map((fileEntry) => {

src/functions/FilesSelector.js

@@ -1,4 +1,4 @@
-// Doc: fonction permettant de sélectionner les différents fichiers
+// Doc: Used to select the files
 
 const FilesSelector = async () => {
     const pickerOptions = {

src/functions/FilterFiles.js

@@ -1,4 +1,12 @@
-// doc: Cette fonction filre les fichiers selon les extensions choisis et renvoie le tableau des fichiers filtres
+// doc: Can filter files based on the selected extensions and returns the array of filtered files.
+
+
+
+
+
+
+
+
 
 const FilterFiles = async (files, extensions) => {
     let filesArray = [];

src/functions/FolderSelector.js

@@ -1,6 +1,6 @@
 const GetAllFiles = require("./GetAllFiles");
 
-// doc: Fonction pour sélectionner un dossier
+// doc: Used to select a folder
 const FolderSelector = async () => {
     try {
         const directoryHandle = await window.showDirectoryPicker();

src/functions/GetAllFiles.js

@@ -1,4 +1,4 @@
-// Doc: Permet d'attraper récursivement les fichiers dans les différents dossiers et sous-dossier
+// Doc: Catch files recursively in subdirectories
 
 const GetAllFiles = async (directoryHandle, files) => {
     for await (const entry of directoryHandle.values()) {

src/functions/OutputNameFileMarkdown.js

@@ -1,4 +1,4 @@
-// doc: ajoute le .md a la fin du project Name
+// doc: Add .md at the end of projectName
 
 const OutputNameFileMarkdown = (projectName) => {
     const extension = ".md";

src/functions/OutputNameFilePDF.js

@@ -1,4 +1,4 @@
-// doc: ajoute le .pdf a la fin du project Name
+// doc: Add .pdf at the end of projectName
 
 const OutputNameFilePDF = (projectName) => {
     const extension = ".pdf";