[SDK] Add @module and @overview JSDoc Tag for TypeDoc Documentation Generation #5817
Description
Summary
Add @module and @overview JSDoc tag in Eclipse Dirigible TypeScript APIs, enabling developers to define high-level module or package descriptions that can be automatically picked up by TypeDoc and used to generate structured documentation pages.
Motivation
When generating documentation with TypeDoc, there is currently no standardized way to define a clear, human-readable overview for a module, package, or library entry point. This leads to:
- Poorly structured landing pages in generated documentation
- Lack of context for first-time users of APIs
- Over-reliance on README files, which are not always integrated into TypeDoc output
Adding @module and @overview tags would allow developers to embed meaningful documentation directly in the codebase, improving discoverability and consistency.
Proposed Solution
/**
* @module core/configurations
* @overview
*
* The Configurations API provides a centralized, type-safe interface for managing application configuration properties and detecting the runtime operating system. It serves as the foundation for environment-specific settings and system-aware behavior in Aerokit applications.
*
* ### Key Features
* ...