docs(batch): create API docs for the utility

[dreamorosi]

Description of your changes

This PR improves the documentation around types, functions, classes, and methods for the upcoming Batch Processing utility. The documentation is provided via docstrings and follows the conventions already present in the project.

While working on the PR I also strengthened some of the types and changed the access modifier of all the methods that didn't need to be public from public to private or protected.

Related issues, RFCs

Issue number: #1620

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my change is effective and works
• The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication