svn commit: r1068542 - /subversion/trunk/subversion/include/svn_io.h

[bl...@apache.org]

Author: blair
Date: Tue Feb  8 19:46:19 2011
New Revision: 1068542

URL: http://svn.apache.org/viewvc?rev=1068542&view=rev
Log:
Add some additional documentation.

* subversion/include/svn_io.h
  (svn_stream_mark_t):
    Document that there is no concrete defintion of this struct, it's
    a named obaque type.

Modified:
    subversion/trunk/subversion/include/svn_io.h

Modified: subversion/trunk/subversion/include/svn_io.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=1068542&r1=1068541&r2=1068542&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Tue Feb  8 19:46:19 2011
@@ -757,7 +757,9 @@ typedef svn_error_t *(*svn_write_fn_t)(v
 /** Close handler function for a generic stream.  @see svn_stream_t. */
 typedef svn_error_t *(*svn_close_fn_t)(void *baton);
 
-/** An opaque type which represents a mark on a stream.
+/** An opaque type which represents a mark on a stream.  There is no
+ * concrete definition of this type, it is a named type for stream
+ * implementation specific baton pointers.
  *
  * @see svn_stream_mark().
  * @since New in 1.7.