From d31076f6342d1effa2d36fff6f70eb0ec1165a20 Mon Sep 17 00:00:00 2001 From: RealRichi3 Date: Wed, 12 Jun 2024 03:32:05 +0100 Subject: [PATCH] rm globals1.qmd --- CHANGELOG.md | 2 +- docs/chapters/globals/globals1.qmd | 117 ----------------------------- 2 files changed, 1 insertion(+), 118 deletions(-) delete mode 100644 docs/chapters/globals/globals1.qmd diff --git a/CHANGELOG.md b/CHANGELOG.md index cf4534c1..20e9293e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ All notable changes to this project will be documented in this file. See [standa ### Bug Fixes * incorrect file paths while merging crowdin translations ([0196156](https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto/commit/01961566ef87639cb120d6704b401473d7a7c969)) -* translations dir in config ([cfa81fc](https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto/commit/cfa81fc650b0d52ee2e1b830fa0a0d131fd7b43f)) +* incorrect translations directory in default config ([cfa81fc](https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto/commit/cfa81fc650b0d52ee2e1b830fa0a0d131fd7b43f)) ## 1.0.4 (2024-06-11) diff --git a/docs/chapters/globals/globals1.qmd b/docs/chapters/globals/globals1.qmd deleted file mode 100644 index 73588146..00000000 --- a/docs/chapters/globals/globals1.qmd +++ /dev/null @@ -1,117 +0,0 @@ -# Globals - -global constructs - - - -## getJSFilesFromDirectory -`[function]` - -**Description:** -This function recursively traverses the specified directory and its subdirectories to find JavaScript files (.js). - It starts by checking each item in the directory. If the item is a directory, it recursively calls itself - to search for JavaScript files within that directory. If the item is a JavaScript file, it adds the file path - to an array of found JavaScript files. - - - - - -## start -`[function]` - -**Description:** -Starts the documentation generation process. - - This function initiates the documentation generation process by performing the following steps: - - 1. It searches for JavaScript files in the specified directory and its subdirectories. - 2. It parses the comments from each JavaScript file using `CommentsUtil.getCommentsFromFile()`. - 3. It processes the comments to extract module information and updates the module and category data structures accordingly. - 4. If a default module is defined, it adds the module and its documentation to the appropriate category or the default category. - 5. It generates the documentation directory and files using the `Writer` utility. - 6. Finally, it logs a message indicating that the documentation generation process is complete. - - This function serves as the entry point for generating documentation for JavaScript files. - - - - - -## path_1 -`[variable]` - - - -## moveTranslatedFilesToOutputDir -`[function]` - - - -## fixTranslatedFilesStructureInOutputDir -`[function]` - - - -## mergePathsForTranslatedFiles -`[function]` - -**Description:** -This is necessary because the Crowdin CLI creates a folder for each language - and places the translated files within that folder. This function will move the files from the language folder - to the same level as the original files. - - - -## fixFileExtensionsForTranslatedFiles -`[function]` - -**Description:** -The generated crowdin files have this file extension pattern: .. - The problem here is that the can be instead of 'index'. - This will make the generated file to be .. - This function will fix the file name to be .. so it'll be .> - - - -## unknown -`[other]` - - - -## unknown -`[other]` - -**Description:** -This method will convert a string to camel toUpperCase - - -**Examples:** - -```javascript -StringUtil.convertToCamelCase('hello world') => 'helloWorld' - StringUtil.convertToCamelCase('hello-world') => 'helloWorld' - StringUtil.convertToCamelCase('hello_world') => 'helloWorld' - StringUtil.convertToCamelCase('helloWorld') => 'helloWorld' - StringUtil.convertToCamelCase('hello') => 'hello' -``` - - - -## unknown -`[other]` - -**Description:** -This method will convert a string to camel toUpperCase - - -**Examples:** - -```javascript -StringUtil.convertToCamelCase('hello world') => 'helloWorld' - StringUtil.convertToCamelCase('hello-world') => 'helloWorld' - StringUtil.convertToCamelCase('hello_world') => 'helloWorld' - StringUtil.convertToCamelCase('helloWorld') => 'helloWorld' - StringUtil.convertToCamelCase('hello') => 'hello' -``` -