docs: Add comprehensive JSDoc documentation for core tools

[Phosphate5429]

Context

This PR adds comprehensive JSDoc documentation for two core tools in KiloCode to improve developer experience and code maintainability:

• readFileTool.ts: Enhanced with detailed JSDoc comments explaining the file reading functionality, parameters, return values, and usage examples
• executeCommandTool.ts: Enhanced with detailed JSDoc documentation for command execution, error handling, and terminal integration

Why: The existing core tools lacked proper documentation, making it difficult for new developers to understand their functionality, parameters, and usage patterns. This improvement follows JSDoc standards and provides comprehensive examples.

Implementation

Changes Made

1. readFileTool.ts:

   • Added JSDoc documentation for getReadFileToolDescription() function
   • Added JSDoc for interface definitions (LineRange, FileEntry, FileResult)
   • Added comprehensive JSDoc for main readFileTool() function with:
     • Detailed parameter descriptions
     • Return value documentation
     • Usage examples for single and multiple file reading
     • Line range usage examples

2. executeCommandTool.ts:

   • Added JSDoc for ShellIntegrationError class
   • Added comprehensive JSDoc for main executeCommandTool() function with:
     • Detailed parameter descriptions
     • Return value documentation
     • Usage examples for different command types
   • Added JSDoc for ExecuteCommandOptions type
   • Added JSDoc for executeCommand() function with detailed examples

Documentation Standards

• All JSDoc comments are written in French to match the existing codebase style
• Follows JSDoc 3.x standards with proper tags (@param, @returns, @example)
• Includes type information and detailed descriptions
• Provides practical usage examples
• Documents error scenarios and edge cases

Screenshots

No screenshots applicable - this is a documentation-only change.

How to Test

1. IDE Integration Test:

   • Open the files in VS Code or any IDE with JSDoc support
   • Hover over the documented functions to see the tooltips
   • Verify that parameter hints appear when calling the functions

2. TypeScript Compilation Test:

   cd kilocode
   pnpm check-types

   • Ensure no TypeScript errors are introduced
   • Verify that type definitions are properly recognized

3. Documentation Generation Test:

   # If using JSDoc documentation generator
   npx jsdoc src/core/tools/readFileTool.ts src/core/tools/executeCommandTool.ts

   • Verify that documentation is generated correctly

4. Code Review Test:

   • Review the JSDoc comments in the IDE
   • Verify that all public functions and interfaces are documented
   • Check that examples are syntactically correct and functional

Get in Touch

Discord: Phosphate5429

---

Changeset: This PR includes a changeset (patch level) for proper versioning.

[changeset-bot]

🦋 Changeset detected

Latest commit: bb761a9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
kilo-code	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR