Updated Basic Platform documentation

Author: TheMostDiligent

Graphics/HLSL2GLSLConverterLib/interface/HLSL2GLSLConverter.h

@@ -88,7 +88,7 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_HLSL2GLSLConverter =
 
 // clang-format off
 
-/// Interface to the buffer object implemented in OpenGL
+/// HLSL to GLSL converter interface.
 DILIGENT_BEGIN_INTERFACE(IHLSL2GLSLConverter, IObject)
 {
     VIRTUAL void METHOD(CreateStream)(THIS_

Platforms/Basic/interface/BasicFileSystem.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -137,6 +137,7 @@ struct FindFileData
     bool   IsDirectory = false;
 };
 
+/// Basic platform-specific file system functions
 struct BasicFileSystem
 {
 public:
@@ -173,9 +174,9 @@ struct BasicFileSystem
     /// Splits path into individual components optionally simplifying it.
     ///
     /// If Simplify is true:
-    ///     - Removes redundant slashes (a///b -> a/b)
-    ///     - Removes redundant . (a/./b -> a/b)
-    ///     - Collapses .. (a/b/../c -> a/c)
+    ///     - Removes redundant slashes (`a///b -> a/b`)
+    ///     - Removes redundant `.` (`a/./b -> a/b`)
+    ///     - Collapses `..` (`a/b/../c -> a/c`)
     static std::vector<String> SplitPath(const Char* Path, bool Simplify);
 
     /// Builds a path from the given components.
@@ -184,12 +185,12 @@ struct BasicFileSystem
     /// Simplifies the path.
 
     /// The function performs the following path simplifications:
-    /// - Normalizes slashes using the given slash symbol (a\b/c -> a/b/c)
-    /// - Removes redundant slashes (a///b -> a/b)
-    /// - Removes redundant . (a/./b -> a/b)
-    /// - Collapses .. (a/b/../c -> a/c)
-    /// - Removes trailing slashes (/a/b/c/ -> /a/b/c)
-    /// - When 'Slash' is Windows slash ('\'), removes leading slashes (\a\b\c -> a\b\c)
+    /// - Normalizes slashes using the given slash symbol (`a\b/c -> a/b/c`)
+    /// - Removes redundant slashes (`a///b -> a/b`)
+    /// - Removes redundant `.` (`a/./b `-> `a/b`)
+    /// - Collapses `..` (`a/b/../c -> a/c`)
+    /// - Removes trailing slashes (`/a/b/c/ -> /a/b/c`)
+    /// - When 'Slash' is Windows slash (`\`), removes leading slashes (`\a\b\c -> a\b\c`)
     static std::string SimplifyPath(const Char* Path, Char Slash = 0);
 
 

Platforms/Basic/interface/BasicPlatformDebug.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2024 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,6 +57,7 @@ enum class TextColor
     Gray
 };
 
+/// Basic platform-specific debug functions
 struct BasicPlatformDebug
 {
     static String FormatAssertionFailedMessage(const Char* Message,

Platforms/Basic/interface/BasicPlatformMisc.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2024 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,6 +42,7 @@ enum class ThreadPriority
     Highest
 };
 
+/// Basic platform-specific miscellaneous functions
 struct BasicPlatformMisc
 {
     template <typename Type>