jyapayne/Sunshine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: improvements to source code documentation (#1236)

Browse source
This commit is contained in:
ReenigneArcher 2023-05-07 15:01:44 -04:00 • committed by GitHub
commit 979f7f4e60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
71 changed files with 1284 additions and 1430 deletions
Download patch file Download diff file Expand all files Collapse all files

50
src/nvhttp.cpp
View file

@ -1,6 +1,6 @@
/**
* @file nvhttp.h
*/
* @file nvhttp.h
*/
// macros
#define BOOST_BIND_GLOBAL_PLACEHOLDERS
@ -522,15 +522,15 @@ namespace nvhttp {
}
/**
* @brief Compare the user supplied pin to the Moonlight pin.
* @param pin The user supplied pin.
* @return `true` if the pin is correct, `false` otherwise.
*
* EXAMPLES:
* ```cpp
* bool pin_status = nvhttp::pin("1234");
* ```
*/
* @brief Compare the user supplied pin to the Moonlight pin.
* @param pin The user supplied pin.
* @return `true` if the pin is correct, `false` otherwise.
*
* EXAMPLES:
* ```cpp
* bool pin_status = nvhttp::pin("1234");
* ```
*/
bool
pin(std::string pin) {
pt::ptree tree;
@ -889,13 +889,13 @@ namespace nvhttp {
}
/**
* @brief Start the nvhttp server.
*
* EXAMPLES:
* ```cpp
* nvhttp::start();
* ```
*/
* @brief Start the nvhttp server.
*
* EXAMPLES:
* ```cpp
* nvhttp::start();
* ```
*/
void
start() {
auto shutdown_event = mail::man->event<bool>(mail::shutdown);
@ -1035,13 +1035,13 @@ namespace nvhttp {
}
/**
* @brief Remove all paired clients.
*
* EXAMPLES:
* ```cpp
* nvhttp::erase_all_clients();
* ```
*/
* @brief Remove all paired clients.
*
* EXAMPLES:
* ```cpp
* nvhttp::erase_all_clients();
* ```
*/
void
erase_all_clients() {
map_id_client.clear();