Skip to content

Commit a6a619e

Browse files
committed
docs: enhance JSDoc documentation across core modules
- Improve JSDoc comments in src/commands/move.ts - Update documentation in src/core/content-joiner.ts and file-operations.ts - Enhance path utilities documentation in src/utils/path-utils.ts - Fix code fence formatting issues in JSDoc examples - Add comprehensive parameter descriptions and return types
1 parent b60c31e commit a6a619e

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

src/commands/move.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface MoveOptions {
4141
*
4242
* // Mixed patterns
4343
* await expandSourcePatterns(['README.md', 'docs/*.md']);
44-
* ```;
44+
* ```
4545
*
4646
* @param patterns - Array of file patterns or direct paths to expand
4747
* @param verbose - Whether to output detailed expansion information

src/core/content-joiner.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export class ContentJoiner {
8080
* handleFrontmatter: 'first' // Use first file's frontmatter
8181
* }
8282
* );
83-
* ```;
83+
* ```
8484
*
8585
* @param filePaths - Array of file paths to join together
8686
* @param options - Configuration options for the join operation

src/core/file-operations.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export class FileOperations {
7979
* dryRun: true,
8080
* verbose: true
8181
* });
82-
* ```;
82+
* ```
8383
*
8484
* @param sourcePath - The current path of the markdown file to move
8585
* @param destinationPath - The target path (can be a directory)

src/utils/path-utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export class PathUtils {
4343
*
4444
* PathUtils.resolvePath('../file.md', '/current/working/dir');
4545
* // Returns: '/current/working/file.md'
46-
* ```;
46+
* ```
4747
*
4848
* @param path - The path to resolve (supports ~/, relative, and absolute paths)
4949
* @param basePath - Optional base directory for relative path resolution

0 commit comments

Comments
 (0)