docs(src): add examples alias and general cleanup (#2763)

src/platform/windows/nvprefs/driver_settings.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/driver_settings.cpp
+ * @brief Definitions for nvidia driver settings.
+ */
 // local includes
 #include "driver_settings.h"
 #include "nvprefs_common.h"

src/platform/windows/nvprefs/driver_settings.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/driver_settings.h
+ * @brief Declarations for nvidia driver settings.
+ */
 #pragma once
 
 // nvapi headers

src/platform/windows/nvprefs/nvapi_opensource_wrapper.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/nvapi_opensource_wrapper.cpp
+ * @brief Definitions for the NVAPI wrapper.
+ */
 // standard library headers
 #include <map>
 

src/platform/windows/nvprefs/nvprefs_common.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/nvprefs_common.cpp
+ * @brief Definitions for common nvidia preferences.
+ */
 // local includes
 #include "nvprefs_common.h"
 #include "src/logging.h"

src/platform/windows/nvprefs/nvprefs_common.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/nvprefs_common.h
+ * @brief Declarations for common nvidia preferences.
+ */
 #pragma once
 
 // sunshine utility header for generic smart pointers

src/platform/windows/nvprefs/nvprefs_interface.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/nvprefs_interface.cpp
+ * @brief Definitions for nvidia preferences interface.
+ */
 // standard includes
 #include <cassert>
 

src/platform/windows/nvprefs/nvprefs_interface.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/nvprefs_interface.h
+ * @brief Declarations for nvidia preferences interface.
+ */
 #pragma once
 
 // standard library headers

src/platform/windows/nvprefs/undo_data.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/undo_data.cpp
+ * @brief Definitions for undoing changes to nvidia preferences.
+ */
 // external includes
 #include <nlohmann/json.hpp>
 

src/platform/windows/nvprefs/undo_data.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/undo_data.h
+ * @brief Declarations for undoing changes to nvidia preferences.
+ */
 #pragma once
 
 // standard library headers

src/platform/windows/nvprefs/undo_file.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/undo_file.cpp
+ * @brief Definitions for the nvidia undo file.
+ */
 // local includes
 #include "undo_file.h"
 

src/platform/windows/nvprefs/undo_file.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/platform/windows/nvprefs/undo_file.h
+ * @brief Declarations for the nvidia undo file.
+ */
 #pragma once
 
 // standard library headers