docs: more doxygen fixes (#2736)

This commit is contained in:
ReenigneArcher 2024-06-20 21:34:27 -04:00 committed by GitHub
parent f3abf59fbf
commit acd9ae606e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 13 additions and 7 deletions

View File

@ -31,11 +31,9 @@ dnf -y update
dnf -y group install "Development Tools"
dnf -y install \
cmake-3.27.* \
doxygen \
gcc-13.2.* \
gcc-c++-13.2.* \
git \
graphviz \
libappindicator-gtk3-devel \
libcap-devel \
libcurl-devel \
@ -59,7 +57,6 @@ dnf -y install \
openssl-devel \
opus-devel \
pulseaudio-libs-devel \
python3.11 \
rpm-build \
wget \
which \
@ -119,6 +116,7 @@ cmake \
-DSUNSHINE_ENABLE_X11=ON \
-DSUNSHINE_ENABLE_DRM=ON \
-DSUNSHINE_ENABLE_CUDA=ON \
-DTESTS_ENABLE_PYTHON_TESTS=OFF \
/build/sunshine
make -j "$(nproc)"
cpack -G RPM

View File

@ -910,8 +910,7 @@ WARN_IF_UNDOC_ENUM_VAL = NO
# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
# The default value is: NO.
WARN_AS_ERROR = NO
# todo - ideally this will eventually become FAIL_ON_WARNINGS
WARN_AS_ERROR = FAIL_ON_WARNINGS
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
@ -2457,7 +2456,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
PREDEFINED = DOXYGEN
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The

View File

@ -339,6 +339,9 @@ namespace egl {
return eglGetError() != EGL_SUCCESS;
}
/**
* @memberof egl::display_t
*/
display_t
make_display(std::variant<gbm::gbm_t::pointer, wl_display *, _XDisplay *> native_display) {
constexpr auto EGL_PLATFORM_GBM_MESA = 0x31D7;

View File

@ -17,7 +17,7 @@
* The classes defined in this macro block should only be used by
* cpp files whose compilation depends on SUNSHINE_BUILD_WAYLAND
*/
#ifdef SUNSHINE_BUILD_WAYLAND
#if defined(SUNSHINE_BUILD_WAYLAND) || defined(DOXYGEN)
namespace wl {
using display_internal_t = util::safe_ptr<wl_display, wl_display_disconnect>;

View File

@ -370,6 +370,9 @@ namespace platf::dxgi {
return 0;
}
/**
* @memberof platf::dxgi::display_ram_t
*/
int
display_ram_t::dummy_img(platf::img_t *img) {
if (complete_img(img, true)) {

View File

@ -1583,6 +1583,9 @@ namespace platf::dxgi {
}
// This cannot use ID3D11DeviceContext because it can be called concurrently by the encoding thread
/**
* @memberof platf::dxgi::display_vram_t
*/
int
display_vram_t::dummy_img(platf::img_t *img_base) {
return complete_img(img_base, true);