svn commit: r1402868 - /apr/apr/trunk/include/apr_strings.h

[sf...@apache.org]

Author: sf
Date: Sat Oct 27 21:01:35 2012
New Revision: 1402868

URL: http://svn.apache.org/viewvc?rev=1402868&view=rev
Log:
Document that some string functions check that the input string is not NULL

Modified:
    apr/apr/trunk/include/apr_strings.h

Modified: apr/apr/trunk/include/apr_strings.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_strings.h?rev=1402868&r1=1402867&r2=1402868&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_strings.h (original)
+++ apr/apr/trunk/include/apr_strings.h Sat Oct 27 21:01:35 2012
@@ -90,7 +90,7 @@ APR_DECLARE(int) apr_strnatcasecmp(char 
  * duplicate a string into memory allocated out of a pool
  * @param p The pool to allocate out of
  * @param s The string to duplicate
- * @return The new string
+ * @return The new string or NULL if s == NULL
  */
 APR_DECLARE(char *) apr_pstrdup(apr_pool_t *p, const char *s);
 
@@ -100,7 +100,7 @@ APR_DECLARE(char *) apr_pstrdup(apr_pool
  * @param p The pool to allocate out of
  * @param s The block of characters to duplicate
  * @param n The number of characters to duplicate
- * @return The new string
+ * @return The new string or NULL if s == NULL
  * @remark This is a faster alternative to apr_pstrndup, for use
  *         when you know that the string being duplicated really
  *         has 'n' or more characters.  If the string might contain
@@ -118,7 +118,7 @@ APR_DECLARE(char *) apr_pstrmemdup(apr_p
  * @param p The pool to allocate out of
  * @param s The string to duplicate
  * @param n The maximum number of characters to duplicate
- * @return The new string
+ * @return The new string or NULL if s == NULL
  * @remark The amount of memory allocated from the pool is the length
  *         of the returned string including the NUL terminator
  */
@@ -130,7 +130,7 @@ APR_DECLARE(char *) apr_pstrndup(apr_poo
  * @param p The pool to allocate from
  * @param m The memory to duplicate
  * @param n The number of bytes to duplicate
- * @return The new block of memory
+ * @return The new block of memory or NULL if m == NULL
  */
 APR_DECLARE(void *) apr_pmemdup(apr_pool_t *p, const void *m, apr_size_t n)
 #if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))