Changeset 1217 for trunk/lib/SVN.h

Timestamp:

Oct 10, 2010, 2:46:37 AM (13 years ago)

Author:

Peter Johansson

Message:

update docs and remove third argument in cleanup_failed_init since the bool was not used in function. refs #371

File:

• trunk/lib/SVN.h (modified) (2 diffs)

trunk/lib/SVN.h

@@ -243 +243 @@
        @brief Free resources when svn API calls fail.
 
-       This function will write an error message to stdout, free \a
-       err and \a pool resources. If \a err or \a pool are a NULL
-       pointers the function will do nothing with these resources. If
-       \a mute is true, no error message is written.
-
-       cleanup will throw a SVNException if \a message has
-       length>0. The default bahaviour is to free resources and return
-       normally.
+       This function will free \a pool resources and throw an
+       exception holding the \a message. If mute is false, the thrown
+       exception also contains \a err.
+
+       \throw cleanup will throw a SVNException
 
        @see SVNException
@@ -267 +264 @@
        @see SVNException
     */
-    void cleanup_failed_init(svn_error_t *err, const std::string& message,
-                             bool mute=false);
+    void cleanup_failed_init(svn_error_t *err, const std::string& message);
 
     static SVN* instance_;