docs(src): fix some doxygen warnings (#2731)

This commit is contained in:
ReenigneArcher
2024-06-19 21:36:09 -04:00
committed by GitHub
parent 429019e47b
commit f3abf59fbf
12 changed files with 15 additions and 74 deletions

View File

@@ -498,8 +498,8 @@ namespace cuda {
/**
* @brief Create a GL->CUDA encoding device for consuming captured dmabufs.
* @param in_width Width of captured frames.
* @param in_height Height of captured frames.
* @param width Width of captured frames.
* @param height Height of captured frames.
* @param offset_x Offset of content in captured frame.
* @param offset_y Offset of content in captured frame.
* @return FFmpeg encoding device context.

View File

@@ -778,13 +778,6 @@ namespace platf {
return 0;
}
/**
* @brief Creates a new virtual gamepad.
* @param id The gamepad ID.
* @param metadata Controller metadata from client (empty if none provided).
* @param feedback_queue The queue for posting messages back to the client.
* @return 0 on success.
*/
int
alloc_gamepad(const gamepad_id_t &id, const gamepad_arrival_t &metadata, feedback_queue_t &&feedback_queue) {
TUPLE_2D_REF(input, gamepad_state, gamepads[id.globalIndex]);
@@ -1599,14 +1592,6 @@ namespace platf {
keyboard_ev(kb, KEY_LEFTCTRL, 0);
}
/**
* @brief Creates a new virtual gamepad.
* @param input The global input context.
* @param id The gamepad ID.
* @param metadata Controller metadata from client (empty if none provided).
* @param feedback_queue The queue for posting messages back to the client.
* @return 0 on success.
*/
int
alloc_gamepad(input_t &input, const gamepad_id_t &id, const gamepad_arrival_t &metadata, feedback_queue_t feedback_queue) {
return ((input_raw_t *) input.get())->alloc_gamepad(id, metadata, std::move(feedback_queue));

View File

@@ -326,11 +326,6 @@ namespace platf {
lifetime::exit_sunshine(0, true);
}
/**
* @brief Attempt to gracefully terminate a process group.
* @param native_handle The process group ID.
* @return true if termination was successfully requested.
*/
bool
request_process_group_exit(std::uintptr_t native_handle) {
if (kill(-((pid_t) native_handle), SIGTERM) == 0 || errno == ESRCH) {
@@ -343,11 +338,6 @@ namespace platf {
}
}
/**
* @brief Checks if a process group still has running children.
* @param native_handle The process group ID.
* @return true if processes are still running.
*/
bool
process_group_running(std::uintptr_t native_handle) {
return waitpid(-((pid_t) native_handle), nullptr, WNOHANG) >= 0;

View File

@@ -196,8 +196,10 @@ namespace wl {
class display_t {
public:
/**
* Initialize display with display_name
* @brief Initialize display.
* If display_name == nullptr -> display_name = std::getenv("WAYLAND_DISPLAY")
* @param display_name The name of the display.
* @return 0 on success, -1 on failure.
*/
int
init(const char *display_name = nullptr);