docs: improvements to source code documentation

[ReenigneArcher]

Description

This PR improves some of the source code documnetation. Pipe dream is to eventually clean up all of the doxygen errors/warnings. If all errors/warnings can be removed, then we can fail doxygen on warning to force new contributions to document the code properly... too tall a task for this single PR though.

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)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• 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

[LizardByte-bot]

✅ Qodana success ✅
Results:
- js
- python

[ReenigneArcher]

Warnings/Errors list:

• src/config.cpp:42: error: include file ffnvcodec/nv EncodeAPI.h not found, perhaps you forgot to add its directory to INCLUDE_PATH?
• src/input.cpp:849: error: Reached end of file while still inside a (nested) comment. Nesting level 2 (probable line reference: 383, 370)
• src/platform/macos/av_audio.h:26: error: More #endif's than #if's found. (fixed by pragma once)
• src/platform/macos/av_video.h:42: error: More #endif's than #if's found. (fixed by pragma once)
• src/platform/macos/publish.cpp:393: error: Detected potential recursive class relation between class platf::publish::deinit_t and base class platf::deinit_t!
• src/platform/windows/misc.cpp:813: error: Detected potential recursive class relation between class platf::qos_t and base class platf::deinit_t!
• src/platform/linux/wayland.cpp:34: error: no uniquely matching class member found for int wl::display_t::init(const char *display_name)
• src/platform/linux/wayland.cpp:56: error: documented symbol 'void wl::display_t::roundtrip' was not declared or defined.
• src/platform/linux/wayland.cpp:61: error: documented symbol 'wl_registry * wl::display_t::registry' was not declared or defined.
• src/platform/linux/wayland.cpp:75: error: documented symbol 'void wl::monitor_t::xdg_name' was not declared or defined.
• src/platform/linux/wayland.cpp:82: error: documented symbol 'void wl::monitor_t::xdg_description' was not declared or defined.
• src/platform/linux/wayland.cpp:89: error: documented symbol 'void wl::monitor_t::xdg_position' was not declared or defined.
• src/platform/linux/wayland.cpp:97: error: documented symbol 'void wl::monitor_t::xdg_size' was not declared or defined.
• src/platform/linux/wayland.cpp:105: error: documented symbol 'void wl::monitor_t::xdg_done' was not declared or defined.
• src/platform/linux/wayland.cpp:115: error: documented symbol 'wl::interface_t::interface_t' was not declared or defined.
• src/platform/linux/wayland.cpp:124: error: no matching class member found for void wl::interface_t::listen(wl_registry *registry)
• src/platform/linux/wayland.cpp:129: error: documented symbol 'void wl::interface_t::add_interface' was not declared or defined.
• src/platform/linux/wayland.cpp:153: error: documented symbol 'void wl::interface_t::del_interface' was not declared or defined.
• src/platform/linux/wayland.cpp:157: error: documented symbol 'wl::dmabuf_t::dmabuf_t' was not declared or defined.
• src/platform/linux/wayland.cpp:167: error: no matching class member found for void wl::dmabuf_t::listen(zwlr_export_dmabuf_manager_v1 *dmabuf_manager, wl_output *output, bool blend_cursor)
• src/platform/linux/wayland.cpp:174: error: documented symbol 'wl::dmabuf_t::~dmabuf_t' was not declared or defined.
• src/platform/linux/wayland.cpp:181: error: no matching class member found for void wl::dmabuf_t::frame(zwlr_export_dmabuf_frame_v1 *frame, std::uint32_t width, std::uint32_t height, std::uint32_t x, std::uint32_t y, std::uint32_t buffer_flags, std::uint32_t flags, std::uint32_t format, std::uint32_t high, std::uint32_t low, std::uint32_t obj_count)
• src/platform/linux/wayland.cpp:198: error: documented symbol 'void wl::dmabuf_t::object' was not declared or defined.
• src/platform/linux/wayland.cpp:214: error: no uniquely matching class member found for void wl::dmabuf_t::ready(zwlr_export_dmabuf_frame_v1 *frame, std::uint32_t tv_sec_hi, std::uint32_t tv_sec_lo, std::uint32_t tv_nsec)
• src/platform/linux/wayland.cpp:226: error: no matching class member found for void wl::dmabuf_t::cancel(zwlr_export_dmabuf_frame_v1 *frame, std::uint32_t reason)
• src/platform/linux/wayland.cpp:238: error: documented symbol 'void wl::frame_t::destroy' was not declared or defined.
• src/platform/linux/wayland.cpp:248: error: no matching file member found for wl::frame_t::frame_t
• src/platform/windows/display_vram.cpp:1423: error: no uniquely matching class member found for int platf::dxgi::display_vram_t::dummy_img(platf::img_t *img_base)
• src/video.cpp:332: error: no uniquely matching class member found for bool video::encoder_t::@18::operator[](flag_e flag) const
• src/video.cpp:337: error: no uniquely matching class member found for std::bitset< MAX_FLAGS >::reference video::encoder_t::@18::operator[](flag_e flag)
• src/task_pool.h:149: error: The following parameter of task_pool_util::TaskPool::delay(task_id_t task_id, std::chrono::duration< X, Y > duration) is not documented: parameter 'task_id'
• src/platform/linux/input.cpp:1431: error: Unsupported xml/html tag <HEXCODE> found

Undocumented warnings:

Enable WARN_IF_UNDOCUMENTED in Doxyfile. Example errors:

• src/platform/macos/av_audio.h:10: error: Compound AVAudio is not documented.
• src/platform/macos/av_video.h:11: error: Compound AVVideo is not documented.