includes: Added documentation for a few more files

includes/std/string.pat

@@ -2,14 +2,32 @@
 
 #include <std/io.pat>
 
+/*!
+	Libray to interact with strings.
+*/
+
 namespace std::string {
 
+	/**
+	    Base type for sized strings. Represents a string with its size preceeding it.
+		@tparam SizeType The type of the size field.
+		@tparam DataType The type of the characters.
+	*/
 	struct SizedStringBase<SizeType, DataType> {
 		SizeType size;
 		DataType data[size];
 	} [[sealed, format("std::string::impl::format_sized_string"), transform("std::string::impl::format_sized_string")]];
 
+	/**
+	    A ASCII string with a prefixed size.
+		@tparam SizeType The type of the size field.
+	*/
 	using SizedString<SizeType> = SizedStringBase<SizeType, char>;
+
+	/**
+	    A UTF-16 string with a prefixed size.
+		@tparam SizeType The type of the size field.
+	*/
 	using SizedString16<SizeType> = SizedStringBase<SizeType, char16>;
 
 	namespace impl {
@@ -20,52 +38,109 @@ namespace std::string {
 
 	}
 
+	/**
+		Gets the length of a string.
+		@param string The string to get the length of.
+		@return The length of the string.
+	*/
 	fn length(str string) {
 		return builtin::std::string::length(string);
 	};
 
+	/**
+		Gets the character at a given index.
+		@param string The string to get the character from.
+		@param index The index of the character to get.
+		@return The character at the given index.
+	*/
 	fn at(str string, u32 index) {
 		return builtin::std::string::at(string, index);
 	};
 
+	/**
+		Gets a substring of a string.
+		@param string The string to get the substring from.
+		@param pos The position of the first character of the substring.
+		@param count The number of characters to get.
+		@return The substring.
+	*/
 	fn substr(str string, u32 pos, u32 count) {
 		return builtin::std::string::substr(string, pos, count);
 	};
 
 
+	/**
+		Converts a string to an integer.
+		@param string The string to convert.
+		@param base The base of the number.
+		@return The integer.
+	*/
 	fn parse_int(str string, u8 base) {
 		return builtin::std::string::parse_int(string, base);
 	};
 
+	/**
+		Converts a string to a float.
+		@param string The string to convert.
+		@return The float.
+	*/
 	fn parse_float(str string) {
 		return builtin::std::string::parse_float(string);
 	};
 
 
+	/**
+		Converts any type to a string.
+		@param x The value to convert.
+		@return The string.
+	*/
     fn to_string(auto x) {
         return std::format("{}", x);
     };
 
+	/**
+		Checks if a string starts with a given substring.
+		@param string The string to check.
+		@param part The substring to check for.
+		@return True if the string starts with the substring, false otherwise.
+	*/
     fn starts_with(str string, str part) {
         return std::string::substr(string, 0, std::string::length(part)) == part;
     };
 
+	/**
+		Checks if a string ends with a given substring.
+		@param string The string to check.
+		@param part The substring to check for.
+		@return True if the string ends with the substring, false otherwise.
+	*/
     fn ends_with(str string, str part) {
         return std::string::substr(string, std::string::length(string) - std::string::length(part), std::string::length(part)) == part;
     };
 
-    fn contains(str a, str b) {
-        s32 a_len = std::string::length(a);
-        s32 b_len = std::string::length(b);
+	/**
+		Checks if a string contains a given substring.
+		@param string The string to check.
+		@param part The substring to check for.
+		@return True if the string contains the substring, false otherwise.
+	*/
+    fn contains(str string, str part) {
+        s32 string_len = std::string::length(string);
+        s32 part_len = std::string::length(part);
 
-        for (s32 i = 0, i <= (a_len - b_len), i += 1) {
-            if (std::string::substr(a, i, b_len) == b)
+        for (s32 i = 0, i <= (string_len - part_len), i += 1) {
+            if (std::string::substr(string, i, part_len) == part)
                 return true;
         }
 
         return false;
     };
 
+	/**
+		Reverses a string.
+		@param string The string to reverse.
+		@return The reversed string.
+	*/
     fn reverse(str string) {	
         str result;
         
@@ -79,6 +154,11 @@ namespace std::string {
         return result;
     };
 
+	/**
+		Converts a string to upper case.
+		@param string The string to convert.
+		@return The converted string.
+	*/
     fn to_upper(str string) {
 		str result;
 		
@@ -98,6 +178,11 @@ namespace std::string {
 		return result;
 	};
 	
+	/**
+		Converts a string to lower case.
+		@param string The string to convert.
+		@return The converted string.
+	*/
 	fn to_lower(str string) {
 		str result;
 		
@@ -117,6 +202,13 @@ namespace std::string {
 		return result;
 	};
 
+	/**
+		Replaces all occurrences of a substring with another substring.
+		@param string The string to replace in.
+		@param pattern The substring to replace.
+		@param replace The substring to replace with.
+		@return The string with the replacements.
+	*/
     fn replace(str string, str pattern, str replace) {
     	u32 string_len, pattern_len, replace_len;
 		string_len  = std::string::length(string);