LizardByte / Sunshine

Self-hosted game stream host for Moonlight.
http://app.lizardbyte.dev/Sunshine/
GNU General Public License v3.0
15.41k stars 743 forks source link

docs(src): fix some doxygen warnings #2731

Closed ReenigneArcher closed 1 week ago

ReenigneArcher commented 1 week ago

Description

Some doxygen warning fixes:

Screenshot

Issues Fixed or Closed

Type of Change

Checklist

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.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 8.96%. Comparing base (429019e) to head (cea8490).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2731 +/- ## ====================================== Coverage 8.96% 8.96% ====================================== Files 94 94 Lines 17392 17392 Branches 8270 8270 ====================================== Hits 1560 1560 Misses 12967 12967 Partials 2865 2865 ``` | [Flag](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731/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/2731/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `6.79% <ø> (ø)` | | | [Windows](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `4.16% <ø> (ø)` | | | [macOS-12](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `10.04% <ø> (ø)` | | | [macOS-13](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `9.95% <ø> (ø)` | | | [macOS-14](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `10.24% <ø> (ø)` | | 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/2731?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | Coverage Δ | | |---|---|---| | [src/file\_handler.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?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% <ø> (ø)` | | | [src/platform/common.h](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Fcommon.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL2NvbW1vbi5o) | `34.56% <ø> (ø)` | | | [src/platform/linux/cuda.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Flinux%2Fcuda.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL2xpbnV4L2N1ZGEuY3Bw) | `1.81% <ø> (ø)` | | | [src/platform/linux/misc.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Flinux%2Fmisc.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL2xpbnV4L21pc2MuY3Bw) | `9.20% <ø> (ø)` | | | [src/platform/linux/wayland.h](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Flinux%2Fwayland.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL2xpbnV4L3dheWxhbmQuaA==) | `0.00% <ø> (ø)` | | | [src/platform/macos/input.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Fmacos%2Finput.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL21hY29zL2lucHV0LmNwcA==) | `36.57% <ø> (ø)` | | | [src/platform/macos/misc.mm](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Fmacos%2Fmisc.mm&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL21hY29zL21pc2MubW0=) | `7.02% <ø> (ø)` | | | [src/platform/windows/input.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Fwindows%2Finput.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL3dpbmRvd3MvaW5wdXQuY3Bw) | `1.06% <ø> (ø)` | | | [src/platform/windows/misc.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fplatform%2Fwindows%2Fmisc.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3BsYXRmb3JtL3dpbmRvd3MvbWlzYy5jcHA=) | `1.49% <ø> (ø)` | | | [src/upnp.cpp](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2731?src=pr&el=tree&filepath=src%2Fupnp.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#diff-c3JjL3VwbnAuY3Bw) | `3.01% <ø> (ø)` | |