[UPDATE] the doxygen of the files in the extension

Author: HenraL

vscode/asperheader/src/constants.ts

@@ -2,7 +2,7 @@
  * @file constants.ts
  * @brief Global constants and configuration values for AsperHeader extension
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This module defines all global constants, configuration values, and default settings
@@ -278,32 +278,3 @@ export const authorLogo: string = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA
  * This file serves as the single source of truth for all extension constants.
  * Avoid hardcoding values elsewhere in the codebase - define them here first.
  */
-
-/**
- * @section Usage Guidelines
- * 
- * **Importing Constants:**
- * ```typescript
- * import { extensionName, defaultHeaderLogo } from './constants';
- * ```
- * 
- * **Modifying Behavior:**
- * To change extension behavior, update the appropriate constants in this file.
- * Most behavioral changes require extension restart to take effect.
- * 
- * **Adding New Constants:**
- * - Group related constants in logical sections
- * - Use descriptive names with appropriate prefixes
- * - Include comprehensive JSDoc documentation
- * - Consider type safety and const assertions where appropriate
- * 
- * **ASCII Art Guidelines:**
- * - Use periods (.) for background/empty space
- * - Use hash (#) for foreground/design elements
- * - Maintain consistent line lengths for proper alignment
- * - Test rendering in various monospace fonts
- * 
- * **Configuration Philosophy:**
- * This file serves as the single source of truth for all extension constants.
- * Avoid hardcoding values elsewhere in the codebase - define them here first.
- */

vscode/asperheader/src/extension.ts

@@ -2,7 +2,7 @@
  * @file extension.ts
  * @brief Main extension entry point for AsperHeader VS Code extension
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This file serves as the primary activation point for the AsperHeader VS Code extension,
@@ -19,12 +19,12 @@
  * - Document save event handling with header refresh
  * 
  * The extension integrates multiple specialized modules:
- * - CommentGenerator: Automated header injection and refresh
- * - RandomLogo: ASCII art logo selection and display
- * - Darling: Easter egg functionality with character display
- * - Watermark: Author watermark management
- * - MorseTranslator: Text-to-Morse code conversion utilities
- * - Logger: Dual-channel logging system for development and user feedback
+ * - {@link CommentGenerator}: Automated header injection and refresh
+ * - {@link RandomLogo}: ASCII art logo selection and display
+ * - {@link Darling}: Easter egg functionality with character display
+ * - {@link Watermark}: Author watermark management
+ * - {@link MorseTranslator}: Text-to-Morse code conversion utilities
+ * - {@link logger}: Dual-channel logging system for development and user feedback
  * 
  * @example Extension activation workflow:
  * ```typescript
@@ -52,6 +52,7 @@ import { CommentGenerator } from './modules/commentGenerator';
 import { CodeConfig, CodeConfigType } from "./modules/processConfiguration";
 import { Watermark } from "./modules/watermark";
 import { RandomLogo } from "./modules/randomLogo";
+import { query } from "./modules/querier";
 
 // ---- SHared variables ----
 
@@ -96,6 +97,7 @@ function getFileInfo(editor: vscode.TextEditor) {
 
 /**
  * @brief Displays a simple greeting message from the extension
+ * @return Void - Operation completes synchronously
  * 
  * Basic command implementation showing informational notification
  * to verify extension functionality and user interaction.
@@ -106,6 +108,7 @@ function helloWorldCommand() {
 
 /**
  * @brief Inserts greeting message with current file information
+ * @return Promise<void> - Resolves when message insertion is complete
  * 
  * Advanced hello command that analyzes the active editor and
  * inserts contextual information including file path, extension,
@@ -130,6 +133,7 @@ async function sayHelloWorldCommand() {
 /**
  * @brief Thread-safe document update handler for save events
  * @param document VS Code text document being saved
+ * @return Promise<void> - Resolves when update operation is complete or skipped
  * 
  * Implements concurrency control to prevent multiple simultaneous
  * header updates during save operations. Uses WeakSet tracking
@@ -155,6 +159,7 @@ async function updateSaveSafe(document: vscode.TextDocument) {
 
 /**
  * @brief Updates cached workspace name from VS Code workspace state
+ * @return Void - Updates configuration cache synchronously
  * 
  * Analyzes current workspace configuration to extract and cache
  * the workspace name for use in header generation. Handles both
@@ -174,6 +179,46 @@ function refreshWorkspaceName() {
 	CodeConfig.setWorkspaceName(workspaceName);
 }
 
+/**
+ * @brief Converts user input to Morse code through interactive GUI dialog
+ * @return Promise<void> - Resolves when conversion and display are complete
+ * 
+ * Presents an input dialog for text entry, converts the input to Morse code
+ * using {@link MorseTranslator}, and displays the result through both console
+ * and GUI notification channels.
+ */
+async function toMorseGui() {
+	const usr_input: string | undefined = await query.input(getMessage("toMorseGetInput"));
+	if (usr_input === undefined) {
+		logger.Gui.info(getMessage("operationCanceled"));
+		return;
+	}
+	const converted_response: string = MorseTranslator.toMorse(usr_input);
+	logger.info(getMessage("convertedContentCli", converted_response));
+	logger.Gui.info(getMessage("convertedContentGui"));
+	logger.Gui.info(`${converted_response}`);
+}
+
+/**
+ * @brief Converts Morse code input to plain text through interactive GUI dialog
+ * @return Promise<void> - Resolves when conversion and display are complete
+ * 
+ * Presents an input dialog for Morse code entry, converts the input to plain text
+ * using {@link MorseTranslator}, and displays the result through both console
+ * and GUI notification channels.
+ */
+async function fromMorseGui() {
+	const usr_input: string | undefined = await query.input(getMessage("fromMorseGetInput"));
+	if (usr_input === undefined) {
+		logger.Gui.info(getMessage("operationCanceled"));
+		return;
+	}
+	const converted_response: string = MorseTranslator.fromMorse(usr_input);
+	logger.info(getMessage("convertedContentCli", converted_response));
+	logger.Gui.info(getMessage("convertedContentGui"));
+	logger.Gui.info(`${converted_response}`);
+}
+
 /**
  * @brief Main extension activation entry point
  * @param context VS Code extension context providing access to extension resources
@@ -235,12 +280,15 @@ export async function activate(context: vscode.ExtensionContext) {
 		vscode.commands.registerCommand(`${moduleName}.darling`, DARLING.displayRandomPersonInWindow.bind(DARLING)),
 		vscode.commands.registerCommand(`${moduleName}.author`, WATERMARK.displayRandomAuthorWatermarkInWindow.bind(WATERMARK)),
 		vscode.commands.registerCommand(`${moduleName}.displayRandomLogo`, RANDOM_LOGO.displayRandomLogoInWindow.bind(RANDOM_LOGO)),
+		vscode.commands.registerCommand(`${moduleName}.toMorse`, toMorseGui),
+		vscode.commands.registerCommand(`${moduleName}.fromMorse`, fromMorseGui),
 		vscode.workspace.onDidSaveTextDocument(async (document: vscode.TextDocument) => { await updateSaveSafe(document); })
 	);
 }
 
 /**
  * @brief Extension cleanup and deactivation handler
+ * @return Void - Completes synchronously with no explicit cleanup
  * 
  * Called when extension is deactivated, disabled, or VS Code closes.
  * Currently implements graceful shutdown without explicit cleanup

vscode/asperheader/src/modules/commentGenerator.ts

@@ -2,7 +2,7 @@
  * @file commentGenerator.ts
  * @brief Comprehensive comment and header generation system for AsperHeader extension
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This module serves as the core engine for generating, injecting, and managing 
@@ -21,9 +21,9 @@
  * Key Dependencies:
  * - {@link LazyFileLoader}: Lazy loading of language configuration files
  * - {@link RandomLogo}: ASCII art logo selection and management
- * - {@link querier}: User interaction and input validation
+ * - {@link Query}: User interaction and input validation
  * - {@link logger}: Comprehensive logging and error reporting
- * - {@link processConfiguration}: Extension configuration and workspace settings
+ * - {@link CodeConfig}: Extension configuration and workspace settings
  * 
  * Supported Features:
  * - Multi-line and single-line comment generation
@@ -99,7 +99,7 @@ interface CommentStyle {
  * 
  * Architectural Features:
  * - **Lazy Loading**: Language configurations loaded on-demand for performance
- * - **Configuration Integration**: Deep coupling with {@link CodeConfig} settings
+ * - **Configuration Integration**: Deep coupling with {@link Configuration} settings
  * - **Error Resilience**: Comprehensive error handling and user feedback
  * - **Workspace Awareness**: Context-sensitive behavior based on workspace state
  * - **Multi-Language Support**: Extensible system supporting diverse programming languages
@@ -888,6 +888,7 @@ export class CommentGenerator {
     /**
      * @brief Updates the random logo generator instance
      * @param randomLogoInstance New RandomLogo instance to use
+     * @return Void - Updates instance reference synchronously
      * 
      * Allows external code to update the logo randomizer, useful for
      * dependency injection or runtime reconfiguration.

vscode/asperheader/src/modules/darling.ts

@@ -2,7 +2,7 @@
  * @file darling.ts
  * @brief Interactive character showcase system featuring "Darling in the FranXX" characters with rich presentation
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This module implements an engaging character display system that serves as an Easter egg

vscode/asperheader/src/modules/lazyFileLoad.ts

@@ -2,7 +2,7 @@
  * @file lazyFileLoad.ts
  * @brief Advanced lazy loading file system utility with intelligent caching and type safety
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This module implements a sophisticated lazy loading file system utility that serves as
@@ -121,12 +121,13 @@ export class LazyFileLoader<T = any> {
     }
 
     /**
-     * @brief Checks if a file or directory exists at the given path
+     * @brief Checks if a file or directory exists at the specified path
      * @param filePath Path to check for existence
      * @return Promise resolving to true if path exists, false otherwise
      * 
-     * Utility method that uses fs.promises.access() to check path existence
-     * without throwing exceptions. Used for path validation and resolution.
+     * Utility method for validating file existence before performing operations.
+     * Uses Node.js fs.promises.access() which is the recommended approach for
+     * checking file existence without race conditions.
      */
     async pathExists(filePath: string): Promise<boolean> {
         try {
@@ -136,7 +137,7 @@ export class LazyFileLoader<T = any> {
             return false;
         }
     }
-
+    
     /**
      * @brief Resolves a file path to an absolute path
      * @param filePath Relative or absolute file path to resolve

vscode/asperheader/src/modules/logger.ts

@@ -2,7 +2,7 @@
  * @file logger.ts
  * @brief Advanced dual-channel logging system for VS Code extension development
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This module implements a sophisticated logging infrastructure designed specifically
@@ -545,6 +545,7 @@ class Log {
     /**
      * @brief Updates installation state for dynamic environment changes with UI adaptation
      * @param context Updated VS Code extension context
+     * @return Void - Updates state and UI synchronously
      * 
      * Allows runtime updates to the installation state detection, useful when
      * the extension context becomes available after initial logger creation
@@ -572,6 +573,7 @@ class Log {
      * @brief Logs informational messages with automatic caller identification
      * @param message Information message describing successful operations or status updates
      * @param searchDepth Optional stack depth override for complex calling scenarios
+     * @return Void - Completes logging operation synchronously
      * 
      * Generates comprehensive informational log entries with full context attribution.
      * Suitable for tracking normal operation flow, successful completions, and
@@ -611,6 +613,7 @@ class Log {
      * @brief Records warning conditions requiring attention but not blocking execution
      * @param message Warning description of potential issues or unusual conditions
      * @param searchDepth Optional stack depth override for complex calling scenarios
+     * @return Void - Completes logging operation synchronously
      * 
      * Generates warning-level log entries for conditions that may require attention
      * but don't prevent continued operation. Includes automatic caller attribution
@@ -652,6 +655,7 @@ class Log {
      * @brief Records critical errors requiring immediate attention or investigation
      * @param message Error description detailing failure conditions and context
      * @param searchDepth Optional stack depth override for complex calling scenarios
+     * @return Void - Completes logging operation synchronously
      * 
      * Generates error-level log entries for critical failures, exceptions, and
      * conditions that prevent normal operation. Uses console.error() for proper
@@ -699,6 +703,7 @@ class Log {
      * @brief Generates detailed debugging information when debug mode is enabled
      * @param message Debug message with detailed development information
      * @param searchDepth Optional stack depth override for complex calling scenarios
+     * @return Void - Completes logging operation synchronously (early return if debug disabled)
      * 
      * Produces verbose debugging output for development and troubleshooting scenarios.
      * All debug output is conditionally generated based on extension configuration,

vscode/asperheader/src/modules/messageProvider.ts

@@ -2,7 +2,7 @@
  * @file messageProvider.ts
  * @brief Comprehensive internationalization engine with intelligent language detection and message orchestration
  * @author Henry Letellier
- * @version 1.0.5
+ * @version 1.0.8
  * @date 2025
  * 
  * This module serves as the central internationalization (i18n) engine for the AsperHeader