diff options
author | Murray Cumming <murrayc@murrayc.com> | 2008-03-28 11:55:46 +0000 |
---|---|---|
committer | Murray Cumming <murrayc@src.gnome.org> | 2008-03-28 11:55:46 +0000 |
commit | cbbb33c44be4b30e23a484ec2b0282689c819115 (patch) | |
tree | 3ab40fe8c3446817edb20923fcdd9503ccae93f1 /gio/src/file.hg | |
parent | 8ad11cdf1df5f5c18fd02fff69a749ceb9d81cf0 (diff) | |
download | glibmm-cbbb33c44be4b30e23a484ec2b0282689c819115.tar.gz |
Documentation: Remove/fix mentions of 0 when we mean something else.
2008-03-28 Murray Cumming <murrayc@murrayc.com>
* gio/src/file.hg:
* gio/src/outputstream.hg: Documentation: Remove/fix mentions of 0 when
we mean something else.
svn path=/trunk/; revision=644
Diffstat (limited to 'gio/src/file.hg')
-rw-r--r-- | gio/src/file.hg | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/gio/src/file.hg b/gio/src/file.hg index df41b91a..c447b04e 100644 --- a/gio/src/file.hg +++ b/gio/src/file.hg @@ -290,8 +290,7 @@ public: * * @param cancellable A Cancellable object which can be used to cancel the operation. * @param flags a set of FileCreateFlags. - * @return A FileOutputStream for the newly created file, or - * <tt>0</tt> on error. + * @return A FileOutputStream for the newly created file. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr<FileOutputStream> create_file(const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE); @@ -318,8 +317,7 @@ public: * filesystem the file is on. * * @param flags a set of FileCreateFlags. - * @return A FileOutputStream for the newly created file, or - * <tt>0</tt> on error. + * @return A FileOutputStream for the newly created file. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr<FileOutputStream> create_file(FileCreateFlags flags = FILE_CREATE_NONE); @@ -644,7 +642,7 @@ public: * (the total size of the filesystem in bytes), FILE_ATTRIBUTE_FILESYSTEM_FREE (number of * bytes availible), and FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). * - * If @a cancellable is not <tt>0</tt>, then the operation can be cancelled by + * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED will be thrown. * @@ -801,7 +799,7 @@ public: * @param cancellable A Cancellable object. * @param attributes An attribute query string. * @param flags A set of FileQueryInfoFlags. - * @return A FileEnumerator if successful, <tt>0</tt> on error. + * @return A FileEnumerator if successful. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr<FileEnumerator> enumerate_children(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE); @@ -828,7 +826,7 @@ public: * * @param attributes An attribute query string. * @param flags A set of FileQueryInfoFlags. - * @return A FileEnumerator if successful, <tt>0</tt> on error. + * @return A FileEnumerator if successful. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr<FileEnumerator> enumerate_children(const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE); @@ -1570,7 +1568,6 @@ public: * @param cancellable A Cancellable object. * @param flags A set of FileMonitorFlags. * @return A FileMonitor for the file. - * or <tt>0</tt> on error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr<FileMonitor> monitor_directory(const Glib::RefPtr<Cancellable>& cancellable, FileMonitorFlags flags = FILE_MONITOR_NONE); @@ -1583,7 +1580,6 @@ public: * * @param flags A set of FileMonitorFlags. * @return A FileMonitor for the file. - * or <tt>0</tt> on error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr<FileMonitor> monitor_directory(FileMonitorFlags flags = FILE_MONITOR_NONE); @@ -1766,7 +1762,7 @@ public: /** Replaces the contents of the file with @a contents of @a length bytes. * - * If @a etag is specified (not <tt>0</tt>) any existing file must have that etag, or + * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. @@ -1795,7 +1791,7 @@ public: /** Replaces the contents of the file with @a contents of @a length bytes. * - * If @a etag is specified (not <tt>0</tt>) any existing file must have that etag, or + * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. @@ -1819,7 +1815,7 @@ public: /** Replaces the contents of the file with @a contents. * - * If @a etag is specified (not <tt>0</tt>) any existing file must have that etag, or + * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. @@ -1847,7 +1843,7 @@ public: /** Replaces the contents of the file with @a contents. * - * If @a etag is specified (not <tt>0</tt>) any existing file must have that etag, or + * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. @@ -1870,6 +1866,9 @@ public: _IGNORE(g_file_replace_contents) + //TODO: Add replace_contents() without the etags? + + /** Starts an asynchronous replacement of the file with the given * @a contents of @a length bytes. @a etag will replace the document's * current entity tag. |