Document all functions in the helpers directory

[Femimat]

Contributor checklist

• This pull request is on a separate branch and not the main branch
• I have tested my code with the ./gradlew lintKotlin detekt test command as directed in the testing section of the contributing guide

---

Description

The PR adds doc comments to all the functions and classes in the helpers directory.

Related issue

• Document all functions in the helpers directory #310

[github-actions]

Thank you for the pull request! ❤️

The Scribe-Android team will do our best to address your contribution as soon as we can. If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Android rooms once you're in. Also consider attending our bi-weekly Saturday dev syncs. It'd be great to meet you 😊

[github-actions]

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

• The linting and formatting workflows within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[angrezichatterbox]

Thanks for the PR @Femimat. We will get to review it soon :)

[angrezichatterbox]

Everything looks good to me @Femimat

@andrewtavis I think we could add doc strings rule for the files in detekt and ktlint and then create issues and further start enabling them for different files.

[andrewtavis]

Looks great to me as well, @Femimat! Thanks for all the hard work to get the application documented for the community! 😊

[andrewtavis]

I'll make an issue for detekt and ktlint now :)