aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVincent Richard <[email protected]>2004-12-17 16:17:06 +0000
committerVincent Richard <[email protected]>2004-12-17 16:17:06 +0000
commitea87f834bee0ff200684f6d2d7d2b839abda3df8 (patch)
tree054487b453d6a1be706b1a46f29d7a42ae798651
parentAdded @throw in function doc. (diff)
downloadvmime-ea87f834bee0ff200684f6d2d7d2b839abda3df8.tar.gz
vmime-ea87f834bee0ff200684f6d2d7d2b839abda3df8.zip
Updated function doc.
-rw-r--r--src/utility/file.hpp3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/utility/file.hpp b/src/utility/file.hpp
index bf729a31..941018e1 100644
--- a/src/utility/file.hpp
+++ b/src/utility/file.hpp
@@ -101,6 +101,7 @@ public:
/** Create the file pointed by this file object.
+ *
* @throw exceptions::filesystem_exception if an error occurs
*/
virtual void createFile() = 0;
@@ -169,6 +170,8 @@ public:
virtual void rename(const path& newName) = 0;
/** Deletes this file/directory.
+ * If this is a directory, it must be empty.
+ *
* @throw exceptions::filesystem_exception if an error occurs
*/
virtual void remove() = 0;