Review API docs in BI editor

[daneshk]

Purpose

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

Examples

Checklist

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.14%. Comparing base (8704865) to head (9d02686).
⚠️ Report is 17 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #607      +/-   ##
============================================
- Coverage     82.46%   82.14%   -0.33%     
- Complexity      243      371     +128     
============================================
  Files            29       41      +12     
  Lines          1386     1725     +339     
  Branches        193      268      +75     
============================================
+ Hits           1143     1417     +274     
- Misses          196      215      +19     
- Partials         47       93      +46     

☔ 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 reviews and improves API documentation in a cryptographic library by enhancing parameter descriptions and documentation clarity across multiple modules. The changes focus on making documentation more descriptive and user-friendly without altering any functional code.

• Enhanced parameter descriptions to include data types and specific details about expected values
• Improved function documentation to be more descriptive and informative
• Standardized documentation format across all cryptographic operations

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
ballerina/sign_verify.bal	Enhanced documentation for signing and verification functions with clearer parameter descriptions
ballerina/private_public_key.bal	Improved documentation for key management functions and type definitions
ballerina/pgp_utils.bal	Updated enum documentation to be more descriptive about compression and encryption algorithms
ballerina/kem.bal	Enhanced Key Encapsulation Mechanism function documentation with detailed parameter descriptions
ballerina/kdf.bal	Improved Key Derivation Function documentation with clearer parameter explanations
ballerina/hpke.bal	Updated Hybrid Public Key Encryption documentation with more detailed descriptions
ballerina/hmac.bal	Enhanced HMAC function documentation with clearer parameter descriptions
ballerina/hash.bal	Improved hash function documentation with more descriptive parameter and return value descriptions
ballerina/encrypt_decrypt.bal	Enhanced encryption and decryption function documentation with detailed parameter descriptions

---

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

[Copilot]

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[TharmiganK]

LGTM