docs: update file level doxygen blocks (#1258)

This commit is contained in:
ReenigneArcher 2023-05-07 18:12:39 -04:00 committed by GitHub
commit 4ca6dc6c8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
89 changed files with 415 additions and 102 deletions

View file

@ -1,3 +1,7 @@
/**
* @file src/platform/windows/audio.cpp
* @brief todo
*/
#include <audioclient.h>
#include <mmdeviceapi.h>
#include <roapi.h>
@ -678,11 +682,9 @@ namespace platf::audio {
}
/**
* @brief Find the audio device ID given a user-specified name
*
* @param name The name provided by the user
*
* @return The matching device ID, or nothing if not found
* @brief Find the audio device ID given a user-specified name.
* @param name The name provided by the user.
* @return The matching device ID, or nothing if not found.
*/
std::optional<std::wstring>
find_device_id_by_name(const std::string &name) {