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

src/nvenc/nvenc_base.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_base.cpp
+ * @brief Definitions for base NVENC encoder.
+ */
 #include "nvenc_base.h"
 
 #include "src/config.h"
@@ -600,14 +604,6 @@ namespace nvenc {
     return false;
   }
 
-  /**
-   * @brief This function returns the corresponding struct version for the minimum API required by the codec.
-   * @details Reducing the struct versions maximizes driver compatibility by avoiding needless API breaks.
-   * @param version The raw structure version from `NVENCAPI_STRUCT_VERSION()`.
-   * @param v11_struct_version Optionally specifies the struct version to use with v11 SDK major versions.
-   * @param v12_struct_version Optionally specifies the struct version to use with v12 SDK major versions.
-   * @return A suitable struct version for the active codec.
-   */
   uint32_t
   nvenc_base::min_struct_version(uint32_t version, uint32_t v11_struct_version, uint32_t v12_struct_version) {
     assert(minimum_api_version);

src/nvenc/nvenc_base.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_base.h
+ * @brief Declarations for base NVENC encoder.
+ */
 #pragma once
 
 #include "nvenc_colorspace.h"

src/nvenc/nvenc_colorspace.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_colorspace.h
+ * @brief Declarations for base NVENC colorspace.
+ */
 #pragma once
 
 #include <ffnvcodec/nvEncodeAPI.h>

src/nvenc/nvenc_config.h

@@ -1,16 +1,15 @@
+/**
+ * @file src/nvenc/nvenc_config.h
+ * @brief Declarations for base NVENC configuration.
+ */
 #pragma once
 
 namespace nvenc {
 
   enum class nvenc_two_pass {
-    // Single pass, the fastest and no extra vram
-    disabled,
-
-    // Larger motion vectors being caught, faster and uses less extra vram
-    quarter_resolution,
-
-    // Better overall statistics, slower and uses more extra vram
-    full_resolution,
+    disabled,  ///< Single pass, the fastest and no extra vram
+    quarter_resolution,  ///< Larger motion vectors being caught, faster and uses less extra vram
+    full_resolution,  ///< Better overall statistics, slower and uses more extra vram
   };
 
   struct nvenc_config {

src/nvenc/nvenc_d3d11.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_d3d11.cpp
+ * @brief Definitions for base NVENC d3d11.
+ */
 #include "src/logging.h"
 
 #ifdef _WIN32

src/nvenc/nvenc_d3d11.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_d3d11.h
+ * @brief Declarations for base NVENC d3d11.
+ */
 #pragma once
 #ifdef _WIN32
 

src/nvenc/nvenc_encoded_frame.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_encoded_frame.h
+ * @brief Declarations for base NVENC encoded frame.
+ */
 #pragma once
 
 #include <cstdint>

src/nvenc/nvenc_utils.cpp

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_utils.cpp
+ * @brief Definitions for base NVENC utilities.
+ */
 #include <cassert>
 
 #include "nvenc_utils.h"

src/nvenc/nvenc_utils.h

@@ -1,3 +1,7 @@
+/**
+ * @file src/nvenc/nvenc_utils.h
+ * @brief Declarations for base NVENC utilities.
+ */
 #pragma once
 
 #ifdef _WIN32