docs(src): add examples alias and general cleanup

[ReenigneArcher]

Description

• Add @examples and @examples_end aliases.
• Move some documentation blocks to the declarations instead of the definitions.
• Remove unused parameters from cli args, such as --version.
• Document all enums (poorly) and force any new enums to be documented.
• Remove type from return descriptions, as it's redundant.

Screenshot

Issues Fixed or Closed

Type of Change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Dependency update (updates to dependencies)
• [x] Documentation update (changes to documentation)
• [ ] Repository update (changes to repository files, e.g. .github/...)

Checklist

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch must be updated before it can be merged. You must also Allow edits from maintainers.

• [ ] I want maintainers to keep my branch updated

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 42.85714% with 8 lines in your changes missing coverage. Please review.

Project coverage is 8.99%. Comparing base (13f94f1) to head (d02e1a7). Report is 8 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #2763 +/- ## ========================================= + Coverage 8.96% 8.99% +0.02% ========================================= Files 94 94 Lines 17392 17383 -9 Branches 8270 8267 -3 ========================================= + Hits 1560 1564 +4 + Misses 12963 12962 -1 + Partials 2869 2857 -12 ``` | [Flag](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | Coverage Δ | | |---|---|---| | [Linux](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `6.85% <0.00%> (+0.06%)` | :arrow_up: | | [Windows](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `4.16% <0.00%> (ø)` | | | [macOS-12](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `10.01% <46.15%> (-0.04%)` | :arrow_down: | | [macOS-13](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `9.92% <46.15%> (-0.04%)` | :arrow_down: | | [macOS-14](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `10.22% <46.15%> (-0.03%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | Coverage Δ | | |---|---|---| | [src/audio.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Faudio.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2F1ZGlvLmNwcA==) | `28.57% <ø> (ø)` | | | [src/audio.h](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Faudio.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2F1ZGlvLmg=) | `0.00% <ø> (ø)` | | | [src/cbs.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fcbs.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2Nicy5jcHA=) | `7.75% <ø> (ø)` | | | [src/cbs.h](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fcbs.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2Nicy5o) | `33.33% <ø> (ø)` | | | [src/config.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fconfig.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2NvbmZpZy5jcHA=) | `4.77% <ø> (ø)` | | | [src/config.h](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fconfig.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2NvbmZpZy5o) | `0.00% <ø> (ø)` | | | [src/confighttp.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fconfighttp.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2NvbmZpZ2h0dHAuY3Bw) | `1.16% <ø> (+0.38%)` | :arrow_up: | | [src/crypto.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fcrypto.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2NyeXB0by5jcHA=) | `0.81% <ø> (ø)` | | | [src/crypto.h](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Fcrypto.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2NyeXB0by5o) | `0.00% <ø> (ø)` | | | [src/file\_handler.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree&filepath=src%2Ffile_handler.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL2ZpbGVfaGFuZGxlci5jcHA=) | `84.00% <ø> (ø)` | | | ... and [84 more](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2763?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | |