Review API docs in BI editor

[daneshk]

Purpose

Related issue: ballerina-platform/ballerina-library#8275

Examples

Checklist

• Linked to an issue
• Updated the specification
• Updated the changelog
• Added tests
• Checked native-image compatibility

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.72%. Comparing base (5fa91b0) to head (c8ae34b).
⚠️ Report is 1 commits behind head on master.

❌ Your project check has failed because the head coverage (79.72%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #1416   +/-   ##
=========================================
  Coverage     79.72%   79.72%           
  Complexity       66       66           
=========================================
  Files            11       11           
  Lines           286      286           
  Branches         63       63           
=========================================
  Hits            228      228           
  Misses           28       28           
  Partials         30       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull Request Overview

This PR improves the API documentation for the JDBC client module by enhancing clarity, consistency, and detail in function descriptions and parameter explanations.

• Updated client class and function documentation with clearer, more descriptive language
• Enhanced parameter descriptions with consistent formatting and better explanations
• Added missing details about return values and usage patterns

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}