Cleanup

src/core/os.h

@@ -45,6 +45,7 @@ namespace os
 #endif
 	}
 
+	/// Returns whether the @a path exists.
 	inline bool exists(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -54,7 +55,7 @@ namespace os
 #endif
 	}
 
-	/// Returns whether the path is a directory.
+	/// Returns whether @a path is a directory.
 	inline bool is_directory(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -70,7 +71,7 @@ namespace os
 #endif
 	}
 
-	/// Returns whether the path is a regular file.
+	/// Returns whether @a path is a regular file.
 	inline bool is_file(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -115,7 +116,7 @@ namespace os
 #endif
 	}
 
-	/// Creates a regular file.
+	/// Creates a regular file named @a path.
 	inline void create_file(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -137,7 +138,7 @@ namespace os
 #endif
 	}
 
-	/// Deletes a regular file.
+	/// Deletes the file at @a path.
 	inline void delete_file(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -151,7 +152,7 @@ namespace os
 #endif
 	}
 
-	/// Creates a directory.
+	/// Creates a directory named @a path.
 	inline void create_directory(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -166,7 +167,7 @@ namespace os
 #endif
 	}
 
-	/// Deletes a directory.
+	/// Deletes the directory at @a path.
 	inline void delete_directory(const char* path)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -180,10 +181,7 @@ namespace os
 #endif
 	}
 
-	/// Returns the list of @a files in the given @a dir directory. Optionally walks into
-	/// subdirectories whether @a recursive is true.
-	/// @note
-	/// Does not follow symbolic links.
+	/// Returns the list of @a files at the given @a path.
 	inline void list_files(const char* path, Vector<DynamicString>& files)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -233,6 +231,7 @@ namespace os
 #endif
 	}
 
+	/// Returns the current working directory.
 	inline const char* getcwd(char* buf, uint32_t size)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -243,6 +242,7 @@ namespace os
 #endif
 	}
 
+	/// Returns the value of the environment variable @a name.
 	inline const char* getenv(const char* name)
 	{
 #if CROWN_PLATFORM_POSIX
@@ -309,7 +309,8 @@ namespace os
 #endif
 	}
 
-	/// Executes a process.
+	/// Executes the process @a path with the given @a args and returns its exit code.
+	/// It fills @a output with stdout and stderr.
 	inline int execute_process(const char* path, const char* args, StringStream& output)
 	{
 #if CROWN_PLATFORM_POSIX