From cfdacfd2be935a6efc91c753c7643cce4dd23319 Mon Sep 17 00:00:00 2001
From: Rupert Carmichael <5050061-carmiker@users.noreply.gitlab.com>
Date: Sat, 21 Sep 2024 23:53:58 -0400
Subject: [PATCH] bsnes: Document Spec structs

---
 src/bsnes.hpp | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/bsnes.hpp b/src/bsnes.hpp
index c484ce1..c035496 100644
--- 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 */