Author: julianfoad
Date: Thu Jul 8 10:39:25 2010
New Revision: 961702
URL: http://svn.apache.org/viewvc?rev=961702&view=rev
Log:
* subversion/include/private/svn_eol_private.h
(svn_eol__detect_eol): Mention that the result is statically allocated.
(svn_eol__detect_file_eol): Mention that the result is statically allocated.
Tweak the wording.
Modified:
subversion/trunk/subversion/include/private/svn_eol_private.h
Modified: subversion/trunk/subversion/include/private/svn_eol_private.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_eol_private.h?rev=961702&r1=961701&r2=961702&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_eol_private.h (original)
+++ subversion/trunk/subversion/include/private/svn_eol_private.h Thu Jul 8
10:39:25 2010
@@ -58,21 +58,24 @@ svn_eol__find_eol_start(char *buf, apr_s
* no more likely to be incorrect than correct for any caller that
* doesn't.
*
+ * The returned string is statically allocated.
+ *
* @since New in 1.7
*/
const char *
svn_eol__detect_eol(char *buf, char *endp);
-/* Detect the EOL marker used in @a file and return it in @a *eol.
+/* Set @a *eol to the EOL marker used in @a file.
* If it cannot be detected, set @a *eol to NULL.
*
* The file is searched starting at the current file cursor position.
- * The first EOL marker found will be returnd. So if the file has
+ * The first EOL marker found will be returned. So if the file has
* inconsistent EOL markers, this won't be detected.
*
* Upon return, the original file cursor position is always preserved,
* even if an error is thrown.
*
+ * The string @a *eol is statically allocated.
* Do temporary allocations in @a pool.
*
* @since New in 1.7 */
