bsnes: Document Spec structs

libretro · Sep 22, 2024 · cfdacfd · cfdacfd
1 parent 78b9b74
commit cfdacfd
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/bsnes.hpp b/src/bsnes.hpp
@@ -28,6 +28,9 @@
 
 namespace Bsnes {
   namespace Audio {
+    /**
+     * Audio Specifications - Specify audio parameters
+     */
     typedef struct _Spec {
       double freq;                      /**< Output frequency (Hz) */
       unsigned spf;                     /**< Samples per frame (approx) */
@@ -44,6 +47,9 @@ namespace Bsnes {
   }
 
   namespace Video {
+    /**
+     * Video Specifications - Specify video parameters
+     */
     typedef struct _Spec {
       uint32_t *buf;                                            /**< Buffer for raw pixel data */
       void *ptr;                                                /**< User data passed to callback */
@@ -81,6 +87,9 @@ namespace Bsnes {
       constexpr unsigned ButtonR =  (1 << 23);  /**< Mouse: Right Click */
     }
 
+    /**
+     * Input Specifications - Specify input device parameters
+     */
     typedef struct _Spec {
       unsigned port;                                /**< Control Port */
       unsigned device;                              /**< Input::Device type */