1 files changed, 65 insertions, 20 deletions
diff --git a/prism/util/pm_string.h b/prism/util/pm_string.h
index 5f0fc7b046..b0b7c6bf2d 100644
--- a/prism/util/pm_string.h
+++ b/prism/util/pm_string.h
@@ -9,34 +9,80 @@
 #include <stdlib.h>
 #include <string.h>
 
-// This struct represents a string value.
+// The following headers are necessary to read files using demand paging.
+#ifdef _WIN32
+#include <windows.h>
+#else
+#include <fcntl.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#endif
+
+/**
+ * A generic string type that can have various ownership semantics.
+ */
 typedef struct {
+    /** A pointer to the start of the string. */
     const uint8_t *source;
+
+    /** The length of the string in bytes of memory. */
     size_t length;
-    // This field is not the first one, because otherwise things like .pm_string_t_field = 123/pm_constant_id_t does not warn or error
-    enum { PM_STRING_SHARED, PM_STRING_OWNED, PM_STRING_CONSTANT, PM_STRING_MAPPED } type;
+
+    /** The type of the string. This field determines how the string should be freed. */
+    enum {
+        /** This string is a constant string, and should not be freed. */
+        PM_STRING_CONSTANT,
+
+        /** This is a slice of another string, and should not be freed. */
+        PM_STRING_SHARED,
+
+        /** This string owns its memory, and should be freed using `pm_string_free`. */
+        PM_STRING_OWNED,
+
+        /** This string is a memory-mapped file, and should be freed using `pm_string_free`. */
+        PM_STRING_MAPPED
+    } type;
 } pm_string_t;
 
-#define PM_EMPTY_STRING ((pm_string_t) { .type = PM_STRING_CONSTANT, .source = NULL, .length = 0 })
+/**
+ * Returns the size of the pm_string_t struct. This is necessary to allocate the
+ * correct amount of memory in the FFI backend.
+ *
+ * @return The size of the pm_string_t struct.
+ */
+PRISM_EXPORTED_FUNCTION size_t pm_string_sizeof(void);
+
+/**
+ * Defines an empty string. This is useful for initializing a string that will
+ * be filled in later.
+ */
+#define PM_STRING_EMPTY ((pm_string_t) { .type = PM_STRING_CONSTANT, .source = NULL, .length = 0 })
 
 /**
  * Initialize a shared string that is based on initial input.
  *
- * @memberof pm_string_t
+ * @param string The string to initialize.
+ * @param start The start of the string.
+ * @param end The end of the string.
  */
 void pm_string_shared_init(pm_string_t *string, const uint8_t *start, const uint8_t *end);
 
 /**
  * Initialize an owned string that is responsible for freeing allocated memory.
  *
- * @memberof pm_string_t
+ * @param string The string to initialize.
+ * @param source The source of the string.
+ * @param length The length of the string.
  */
 void pm_string_owned_init(pm_string_t *string, uint8_t *source, size_t length);
 
 /**
  * Initialize a constant string that doesn't own its memory source.
  *
- * @memberof pm_string_t
+ * @param string The string to initialize.
+ * @param source The source of the string.
+ * @param length The length of the string.
  */
 void pm_string_constant_init(pm_string_t *string, const char *source, size_t length);
 
@@ -51,14 +97,17 @@ void pm_string_constant_init(pm_string_t *string, const char *source, size_t len
  * `MapViewOfFile`, on POSIX systems that have access to `mmap` we'll use
  * `mmap`, and on other POSIX systems we'll use `read`.
  *
- * @memberof pm_string_t
+ * @param string The string to initialize.
+ * @param filepath The filepath to read.
+ * @return Whether or not the file was successfully mapped.
  */
 PRISM_EXPORTED_FUNCTION bool pm_string_mapped_init(pm_string_t *string, const char *filepath);
 
 /**
  * Returns the memory size associated with the string.
  *
- * @memberof pm_string_t
+ * @param string The string to get the memory size of.
+ * @return The size of the memory associated with the string.
  */
 size_t pm_string_memsize(const pm_string_t *string);
 
@@ -66,35 +115,31 @@ size_t pm_string_memsize(const pm_string_t *string);
  * Ensure the string is owned. If it is not, then reinitialize it as owned and
  * copy over the previous source.
  *
- * @memberof pm_string_t
+ * @param string The string to ensure is owned.
  */
 void pm_string_ensure_owned(pm_string_t *string);
 
 /**
  * Returns the length associated with the string.
  *
- * @memberof pm_string_t
+ * @param string The string to get the length of.
+ * @return The length of the string.
  */
 PRISM_EXPORTED_FUNCTION size_t pm_string_length(const pm_string_t *string);
 
 /**
  * Returns the start pointer associated with the string.
  *
- * @memberof pm_string_t
+ * @param string The string to get the start pointer of.
+ * @return The start pointer of the string.
  */
 PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source(const pm_string_t *string);
 
 /**
  * Free the associated memory of the given string.
  *
- * @memberof pm_string_t
+ * @param string The string to free.
  */
 PRISM_EXPORTED_FUNCTION void pm_string_free(pm_string_t *string);
 
-/**
- * Returns the size of the pm_string_t struct. This is necessary to allocate the
- * correct amount of memory in the FFI backend.
- */
-PRISM_EXPORTED_FUNCTION size_t pm_string_sizeof(void);
-
-#endif // PRISM_STRING_H
+#endif