common/fs/file: Update documentation for {Append/Write}StringToFile

This commit is contained in:
ameerj
2021-06-19 08:55:19 -04:00
parent 371720818e
commit 3d9d0cbd26

View File

@@ -72,6 +72,7 @@ template <typename Path>
/**
* Writes a string to a file at path and returns the number of characters successfully written.
* If a file already exists at path, its contents will be erased.
* If a file does not exist at path, it creates and opens a new empty file for writing.
* If the filesystem object at path is not a file, this function returns 0.
*
* @param path Filesystem path
@@ -95,6 +96,7 @@ template <typename Path>
/**
* Appends a string to a file at path and returns the number of characters successfully written.
* If a file does not exist at path, it creates and opens a new empty file for appending.
* If the filesystem object at path is not a file, this function returns 0.
*
* @param path Filesystem path