docs: update file level doxygen blocks (#1258)

src/platform/linux/audio.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/audio.cpp
+ * @brief todo
+ */
 #include <bitset>
 #include <sstream>
 

src/platform/linux/cuda.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/cuda.cpp
+ * @brief todo
+ */
 #include <bitset>
 
 #include <NvFBC.h>

src/platform/linux/cuda.cu

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/cuda.cu
+ * @brief todo
+ */
 // #include <algorithm>
 #include <helper_math.h>
 #include <chrono>

src/platform/linux/cuda.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/cuda.h
+ * @brief todo
+ */
 #pragma once
 
 #if defined(SUNSHINE_BUILD_CUDA)

src/platform/linux/graphics.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/graphics.cpp
+ * @brief todo
+ */
 #include "graphics.h"
 #include "src/video.h"
 

src/platform/linux/graphics.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/graphics.h
+ * @brief todo
+ */
 #pragma once
 
 #include <optional>

src/platform/linux/input.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/input.cpp
+ * @brief todo
+ */
 #include <fcntl.h>
 #include <linux/uinput.h>
 #include <poll.h>
@@ -1108,7 +1112,7 @@ namespace platf {
    *
    * EXAMPLES:
    * ```cpp
-   * x_move_mouse(input, 10, 10); // Move mouse 10 pixels down and right
+   * x_move_mouse(input, 10, 10);  // Move mouse 10 pixels down and right
    * ```
    */
   static void
@@ -1204,7 +1208,7 @@ namespace platf {
    *
    * EXAMPLES:
    * ```cpp
-   * button_mouse(input, 1, false); // Press left mouse button
+   * button_mouse(input, 1, false);  // Press left mouse button
    * ```
    */
   void
@@ -1336,12 +1340,12 @@ namespace platf {
    * @brief XTest keyboard emulation.
    * @param input The input_t instance to use.
    * @param modcode The moonlight key code.
-   * @param release Whether the event was a press (false) or a release (true)
-   * @param flags SS_KBE_FLAG_* values
+   * @param release Whether the event was a press (false) or a release (true).
+   * @param flags SS_KBE_FLAG_* values.
    *
    * EXAMPLES:
    * ```cpp
-   * x_keyboard(input, 0x5A, false, 0); // Press Z
+   * x_keyboard(input, 0x5A, false, 0);  // Press Z
    * ```
    */
   static void
@@ -1371,12 +1375,12 @@ namespace platf {
    * @brief Keyboard emulation.
    * @param input The input_t instance to use.
    * @param modcode The moonlight key code.
-   * @param release Whether the event was a press (false) or a release (true)
-   * @param flags SS_KBE_FLAG_* values
+   * @param release Whether the event was a press (false) or a release (true).
+   * @param flags SS_KBE_FLAG_* values.
    *
    * EXAMPLES:
    * ```cpp
-   * keyboard(input, 0x5A, false, 0); // Press Z
+   * keyboard(input, 0x5A, false, 0);  // Press Z
    * ```
    */
   void

src/platform/linux/kmsgrab.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/kmsgrab.cpp
+ * @brief todo
+ */
 #include <drm_fourcc.h>
 #include <errno.h>
 #include <fcntl.h>

src/platform/linux/misc.cpp

@@ -1,7 +1,7 @@
 /**
- * @file misc.cpp
+ * @file src/misc.cpp
+ * @brief todo
  */
-
 // standard includes
 #include <fstream>
 

src/platform/linux/misc.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/misc.h
+ * @brief todo
+ */
 #pragma once
 
 #include <unistd.h>

src/platform/linux/publish.cpp

@@ -1,5 +1,9 @@
-
-// adapted from https://www.avahi.org/doxygen/html/client-publish-service_8c-example.html
+/**
+ * @file src/platform/linux/publish.cpp
+ * @brief todo
+ * @note Adapted from https://www.avahi.org/doxygen/html/client-publish-service_8c-example.html
+ * @todo Use a common file for this and src/platform/macos/publish.cpp
+ */
 #include <thread>
 
 #include "misc.h"
@@ -13,7 +17,7 @@ using namespace std::literals;
 namespace avahi {
 
   /**
-   * @brief Error codes used by avahi
+   * @brief Error codes used by avahi.
    */
   enum err_e {
     OK = 0, /**< OK */
@@ -116,7 +120,7 @@ namespace avahi {
   };
 
   /**
-   * @brief Some flags for publishing functions
+   * @brief Flags for publishing functions.
    */
   enum PublishFlags {
     PUBLISH_UNIQUE = 1, /**< For raw records: The RRset is intended to be unique */

src/platform/linux/vaapi.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/vaapi.cpp
+ * @brief todo
+ */
 #include <sstream>
 #include <string>
 
@@ -82,7 +86,7 @@ namespace va {
   };
 
   /**
-   * @brief Currently defined profiles
+   * @brief Defined profiles
    */
   enum class profile_e {
     // Profile ID used for video processing.

src/platform/linux/vaapi.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/vaapi.h
+ * @brief todo
+ */
 #pragma once
 
 #include "misc.h"

src/platform/linux/wayland.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/wayland.cpp
+ * @brief todo
+ */
 #include <wayland-client.h>
 #include <wayland-util.h>
 

src/platform/linux/wayland.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/wayland.h
+ * @brief todo
+ */
 #pragma once
 
 #include <bitset>

src/platform/linux/wlgrab.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/wlgrab.cpp
+ * @brief todo
+ */
 #include "src/platform/common.h"
 
 #include "src/main.h"

src/platform/linux/x11grab.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/x11grab.cpp
+ * @brief todo
+ */
 #include "src/platform/common.h"
 
 #include <fstream>

src/platform/linux/x11grab.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/linux/x11grab.h
+ * @brief todo
+ */
 #pragma once
 
 #include <optional>