doc(filesystem): just a few docs for filesystem stuff

Author: DexrnZacAttack

include/Filesystem/Directory.h

@@ -17,12 +17,20 @@
 
 namespace lce::fs {
 
+    /** Contains other `FSObject`s inside it.
+     *
+     * Can be used as the root of a Filesystem
+     *
+     * @see File
+     * @see Filesystem
+     * @see FSObject
+     */
     class LIBLCE_API Directory : public FSObject {
       public:
         Directory(Directory &&) = default;
         Directory &operator=(Directory &&) = default;
 
-        /**
+        /** Creates a Directory
          *
          * @param name The name of the directory (if root, specify
          * Filesystem::ROOT)
@@ -230,6 +238,7 @@ namespace lce::fs {
         };
 
       private:
+        /** Child objects inside the Directory */
         std::unordered_map<std::wstring, std::unique_ptr<FSObject>> children;
     };
 

include/Filesystem/FSObject.h

@@ -13,6 +13,11 @@
 namespace lce::fs {
     class Directory;
 
+    /** A base Filesystem Object
+     *
+     * @see File
+     * @see Directory
+     */
     class LIBLCE_API FSObject {
         friend class Filesystem;
         friend class Directory;
@@ -110,9 +115,7 @@ namespace lce::fs {
         /** @returns The object's full path */
         [[nodiscard]] std::wstring getPath() const;
 
-        [[nodiscard]] Directory *getParent() const {
-            return this->parent;
-        };
+        [[nodiscard]] Directory *getParent() const { return this->parent; };
 
       private:
         std::wstring name;

include/Filesystem/File.h

@@ -15,6 +15,11 @@
 #include <Filesystem/FSObject.h>
 
 namespace lce::fs {
+    /** Holds data
+     *
+     * @see Directory
+     * @see FSObject
+     */
     class LIBLCE_API File : public FSObject {
       protected:
         friend class Directory;
@@ -74,10 +79,12 @@ namespace lce::fs {
         /// Writes the file to the physical filesystem into the given path
         void writeOut(const std::filesystem::path &path) const;
 
-        /// Writes the file to the physical filesystem into the given path (using end of path as filename)
+        /// Writes the file to the physical filesystem into the given path
+        /// (using end of path as filename)
         void writeOutFullPath(const std::wstring &path) const;
 
-        /// Writes the file to the physical filesystem into the given path (using end of path as filename)
+        /// Writes the file to the physical filesystem into the given path
+        /// (using end of path as filename)
         void writeOutFullPath(const std::filesystem::path &path) const;
 
         /// Writes the file to the physical filesystem to the current dir

include/Filesystem/Filesystem.h

@@ -15,9 +15,14 @@
 
 namespace lce::fs {
 
+    /** Contains a root folder and helper methods for traversing the filesystem
+     *
+     * Can be extended to make custom filesystem types
+     */
     class LIBLCE_API Filesystem {
       public:
         // const const constexpr const const const
+        /** Root directory path */
         static constexpr const wchar_t *const ROOT = L"/";
 
         // hope I did this right
@@ -69,6 +74,7 @@ namespace lce::fs {
         virtual ~Filesystem() = default;
 
       private:
+        /** The root directory of the filesystem */
         std::unique_ptr<Directory> root;
     };
 } // namespace lce::fs