docs: improvements to source code documentation (#1236)

src/platform/macos/av_audio.h

@@ -1,5 +1,4 @@
-#ifndef SUNSHINE_PLATFORM_AV_AUDIO_H
-#define SUNSHINE_PLATFORM_AV_AUDIO_H
+#pragma once
 
 #import <AVFoundation/AVFoundation.h>
 
@@ -22,5 +21,3 @@
 - (int)setupMicrophone:(AVCaptureDevice *)device sampleRate:(UInt32)sampleRate frameSize:(UInt32)frameSize channels:(UInt8)channels;
 
 @end
-
-#endif  //SUNSHINE_PLATFORM_AV_AUDIO_H

src/platform/macos/av_audio.m

@@ -126,7 +126,7 @@
 
     CMSampleBufferGetAudioBufferListWithRetainedBlockBuffer(sampleBuffer, NULL, &audioBufferList, sizeof(audioBufferList), NULL, NULL, 0, &blockBuffer);
 
-    //NSAssert(audioBufferList.mNumberBuffers == 1, @"Expected interlveaved PCM format but buffer contained %u streams", audioBufferList.mNumberBuffers);
+    // NSAssert(audioBufferList.mNumberBuffers == 1, @"Expected interlveaved PCM format but buffer contained %u streams", audioBufferList.mNumberBuffers);
 
     // this is safe, because an interleaved PCM stream has exactly one buffer
     // and we don't want to do sanity checks in a performance critical exec path

src/platform/macos/av_img_t.h

@@ -1,5 +1,4 @@
-#ifndef av_img_t_h
-#define av_img_t_h
+#pragma once
 
 #include "src/platform/common.h"
 
@@ -14,5 +13,3 @@ namespace platf {
     ~av_img_t();
   };
 }  // namespace platf
-
-#endif /* av_img_t_h */

src/platform/macos/av_video.h

@@ -1,5 +1,4 @@
-#ifndef SUNSHINE_PLATFORM_AV_VIDEO_H
-#define SUNSHINE_PLATFORM_AV_VIDEO_H
+#pragma once
 
 #import <AVFoundation/AVFoundation.h>
 
@@ -38,5 +37,3 @@ typedef bool (^FrameCallbackBlock)(CMSampleBufferRef);
 - (dispatch_semaphore_t)capture:(FrameCallbackBlock)frameCallback;
 
 @end
-
-#endif  //SUNSHINE_PLATFORM_AV_VIDEO_H

src/platform/macos/display.mm

@@ -150,12 +150,12 @@ namespace platf {
     }
 
     /**
-   * A bridge from the pure C++ code of the hwdevice_t class to the pure Objective C code.
-   *
-   * display --> an opaque pointer to an object of this class
-   * width --> the intended capture width
-   * height --> the intended capture height
-   */
+     * A bridge from the pure C++ code of the hwdevice_t class to the pure Objective C code.
+     *
+     * display --> an opaque pointer to an object of this class
+     * width --> the intended capture width
+     * height --> the intended capture height
+     */
     static void
     setResolution(void *display, int width, int height) {
       [static_cast<AVVideo *>(display) setFrameWidth:width frameHeight:height];

src/platform/macos/misc.h

@@ -1,5 +1,4 @@
-#ifndef SUNSHINE_PLATFORM_MISC_H
-#define SUNSHINE_PLATFORM_MISC_H
+#pragma once
 
 #include <vector>
 
@@ -14,5 +13,3 @@ namespace dyn {
   handle(const std::vector<const char *> &libs);
 
 }  // namespace dyn
-
-#endif

src/platform/macos/nv12_zero_device.h

@@ -1,5 +1,4 @@
-#ifndef vtdevice_h
-#define vtdevice_h
+#pragma once
 
 #include "src/platform/common.h"
 
@@ -29,5 +28,3 @@ namespace platf {
   };
 
 }  // namespace platf
-
-#endif /* vtdevice_h */

src/platform/macos/publish.cpp

@@ -12,7 +12,9 @@ using namespace std::literals;
 
 namespace avahi {
 
-  /** Error codes used by avahi */
+  /**
+   * @brief Error codes used by avahi
+   */
   enum err_e {
     OK = 0, /**< OK */
     ERR_FAILURE = -1, /**< Generic error code */
@@ -113,7 +115,9 @@ namespace avahi {
     CLIENT_NO_FAIL = 2 /**< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter CLIENT_CONNECTING state and wait for the daemon to appear */
   };
 
-  /** Some flags for publishing functions */
+  /**
+   * @brief Some flags for publishing functions
+   */
   enum PublishFlags {
     PUBLISH_UNIQUE = 1, /**< For raw records: The RRset is intended to be unique */
     PUBLISH_NO_PROBE = 2, /**< For raw records: Though the RRset is intended to be unique no probes shall be sent */
@@ -434,4 +438,4 @@ namespace platf::publish {
 
     return std::make_unique<deinit_t>(std::thread { avahi::simple_poll_loop, poll.get() });
   }
-};  // namespace platf::publish
+}  // namespace platf::publish