Author: svn-role Date: Fri Jan 19 04:00:07 2018 New Revision: 1821587 URL: http://svn.apache.org/viewvc?rev=1821587&view=rev Log: Merge r1821183 from trunk:
* r1821183 Tweaks to doc strings and Doxygen mark-up of 1.10 API changes. Votes: +1: julianfoad, danielsh Modified: subversion/branches/1.10.x/ (props changed) subversion/branches/1.10.x/STATUS subversion/branches/1.10.x/subversion/include/svn_base64.h subversion/branches/1.10.x/subversion/include/svn_client.h subversion/branches/1.10.x/subversion/include/svn_io.h subversion/branches/1.10.x/subversion/include/svn_ra.h subversion/branches/1.10.x/subversion/include/svn_ra_svn.h subversion/branches/1.10.x/subversion/include/svn_repos.h subversion/branches/1.10.x/subversion/include/svn_string.h subversion/branches/1.10.x/subversion/include/svn_xml.h Propchange: subversion/branches/1.10.x/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Fri Jan 19 04:00:07 2018 @@ -99,4 +99,4 @@ /subversion/branches/verify-at-commit:1462039-1462408 /subversion/branches/verify-keep-going:1439280-1546110 /subversion/branches/wc-collate-path:1402685-1480384 -/subversion/trunk:1817837,1817856,1818577-1818578,1818584,1818651,1818662,1818727,1818801,1818803,1818807,1818868,1818871,1819036-1819037,1819043,1819049,1819052,1819093,1819146,1819162,1819444,1819556-1819557,1819603,1819804,1819911,1820518 +/subversion/trunk:1817837,1817856,1818577-1818578,1818584,1818651,1818662,1818727,1818801,1818803,1818807,1818868,1818871,1819036-1819037,1819043,1819049,1819052,1819093,1819146,1819162,1819444,1819556-1819557,1819603,1819804,1819911,1820518,1821183 Modified: subversion/branches/1.10.x/STATUS URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/STATUS?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/STATUS (original) +++ subversion/branches/1.10.x/STATUS Fri Jan 19 04:00:07 2018 @@ -55,11 +55,6 @@ Veto-blocked changes: Approved changes: ================= - * r1821183 - Tweaks to doc strings and Doxygen mark-up of 1.10 API changes. - Votes: - +1: julianfoad, danielsh - * r1821224 Rename and move the new-for-1.10 function 'svn_io_stdin_readline()'. Justification: @@ -68,4 +63,3 @@ Approved changes: https://svn.haxx.se/dev/archive-2018-01/0054.shtml Votes: +1: stsp, julianfoad, danielsh - Modified: subversion/branches/1.10.x/subversion/include/svn_base64.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_base64.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_base64.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_base64.h Fri Jan 19 04:00:07 2018 @@ -51,6 +51,8 @@ extern "C" { * stream will only consist of base64 encoding characters. Be sure to close * the stream when done writing in order to squeeze out the last bit of * encoded data. The stream is allocated in @a pool. + * + * @since New in 1.10. */ svn_stream_t * svn_base64_encode2(svn_stream_t *output, Modified: subversion/branches/1.10.x/subversion/include/svn_client.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_client.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_client.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_client.h Fri Jan 19 04:00:07 2018 @@ -4376,7 +4376,7 @@ typedef struct svn_client_conflict_t svn typedef struct svn_client_conflict_option_t svn_client_conflict_option_t; /** - * A public enumuneration of conflict option IDs. + * A public enumeration of conflict option IDs. * * @since New in 1.10, unless noted otherwise. */ @@ -6506,7 +6506,7 @@ svn_client_list4(const char *path_or_url svn_client_ctx_t *ctx, apr_pool_t *scratch_pool); -/** Similar to svn_client_list4(), but with @a patterm set to @c NULL. +/** Similar to svn_client_list4(), but with @a patterns set to @c NULL. * * @since New in 1.8. * Modified: subversion/branches/1.10.x/subversion/include/svn_io.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_io.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_io.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_io.h Fri Jan 19 04:00:07 2018 @@ -2410,10 +2410,12 @@ svn_io_write_atomic2(const char *final_p apr_pool_t *scratch_pool); /** Similar to svn_io_write_atomic2(), but with @a flush_to_disk set -* to @c TRUE. -* -* @deprecated Provided for backward compatibility with the 1.9 API -*/ + * to @c TRUE. + * + * @since New in 1.9. + * + * @deprecated Provided for backward compatibility with the 1.9 API + */ SVN_DEPRECATED svn_error_t * svn_io_write_atomic(const char *final_path, Modified: subversion/branches/1.10.x/subversion/include/svn_ra.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_ra.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_ra.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_ra.h Fri Jan 19 04:00:07 2018 @@ -1130,13 +1130,12 @@ svn_ra_get_dir(svn_ra_session_t *session apr_pool_t *pool); /** - * Callback type to be used with @a svn_ra_list. It will be invoked for + * Callback type to be used with svn_ra_list(). It will be invoked for * every directory entry found. * * The full path of the entry is given in @a rel_path and @a dirent contains - * various additional information. If @a svn_repos_list has been called - * with @c path_info_only set, only the @c kind element of this struct - * will be valid. + * various additional information. Only the elements of @a dirent specified + * by the @a dirent_fields argument to svn_ra_list() will be valid. * * @a baton is the user-provided receiver baton. @a scratch_pool may be * used for temporary allocations. @@ -1155,21 +1154,21 @@ typedef svn_error_t *(* svn_ra_dirent_re * In @a session, walk the sub-tree starting at @a path at @a revision down * to the given @a depth. For each directory entry found, @a receiver will * be called with @a receiver_baton. The starting @a path will be reported - * as well. Because retrieving elements of a @c svn_dirent_t can be + * as well. Because retrieving elements of a #svn_dirent_t can be * expensive, you need to select them individually via flags set in * @a dirent_fields. * * @a patterns is an optional array of <tt>const char *</tt>. If it is * not @c NULL, only those directory entries will be reported whose last * path segment matches at least one of these patterns. This feature uses - * @c apr_fnmatch for glob matching and requiring '.' to matched by dots + * apr_fnmatch() for glob matching and requiring '.' to matched by dots * in the path. * * @a path must point to a directory and @a depth must be at least - * @c svn_depth_empty. + * #svn_depth_empty. * * If the server doesn't support the 'list' command, return - * @c SVN_ERR_UNSUPPORTED_FEATURE in preference to any other error that + * #SVN_ERR_UNSUPPORTED_FEATURE in preference to any other error that * might otherwise be returned. * * Use @a scratch_pool for temporary memory allocation. Modified: subversion/branches/1.10.x/subversion/include/svn_ra_svn.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_ra_svn.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_ra_svn.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_ra_svn.h Fri Jan 19 04:00:07 2018 @@ -144,7 +144,9 @@ typedef struct svn_ra_svn_cmd_entry_t svn_boolean_t terminate; } svn_ra_svn_cmd_entry_t; -/** Data types defined by the svn:// protocol. */ +/** Data types defined by the svn:// protocol. + * + * @since The typedef name is new in 1.10; the enumerators are not. */ typedef enum { SVN_RA_SVN_NUMBER, Modified: subversion/branches/1.10.x/subversion/include/svn_repos.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_repos.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_repos.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_repos.h Fri Jan 19 04:00:07 2018 @@ -1726,11 +1726,11 @@ svn_repos_stat(svn_dirent_t **dirent, apr_pool_t *pool); /** - * Callback type to be used with @c svn_repos_list. It will be invoked for + * Callback type to be used with svn_repos_list(). It will be invoked for * every directory entry found. * * The full path of the entry is given in @a path and @a dirent contains - * various additional information. If @c svn_repos_list has been called + * various additional information. If svn_repos_list() has been called * with @a path_info_only set, only the @a kind element of this struct * will be valid. * @@ -1751,14 +1751,14 @@ typedef svn_error_t *(* svn_repos_dirent * Walk the sub-tree starting at @a path under @a root up to the given * @a depth. For each directory entry found, @a receiver will be called * with @a receiver_baton. The starting @a path will be reported as well. - * Because retrieving all elements of a @c svn_dirent_t can be expensive, + * Because retrieving all elements of a #svn_dirent_t can be expensive, * you may set @a path_info_only to receive only the path name and the node * kind. The entries will be reported ordered by their path. * * @a patterns is an optional array of <tt>const char *</tt>. If it is * not @c NULL, only those directory entries will be reported whose last * path segment matches at least one of these patterns. This feature uses - * @c apr_fnmatch for glob matching and requiring '.' to matched by dots + * apr_fnmatch() for glob matching and requiring '.' to matched by dots * in the path. * * If @a authz_read_func is not @c NULL, this function will neither report @@ -1768,7 +1768,7 @@ typedef svn_error_t *(* svn_repos_dirent * @a cancel_func and @a cancel_baton. * * @a path must point to a directory and @a depth must be at least - * @c svn_depth_empty. + * #svn_depth_empty. * * Use @a scratch_pool for temporary memory allocation. * Modified: subversion/branches/1.10.x/subversion/include/svn_string.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_string.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_string.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_string.h Fri Jan 19 04:00:07 2018 @@ -530,8 +530,7 @@ svn_cstring_count_newlines(const char *m /** * Return a cstring which is the concatenation of @a strings (an array - * of char *) each followed by @a separator (that is, @a separator - * will also end the resulting string). Allocate the result in @a pool. + * of char *) joined by @a separator. Allocate the result in @a pool. * If @a strings is empty, then return the empty string. * If @a trailing_separator is non-zero, also append the separator * after the last joined element. Modified: subversion/branches/1.10.x/subversion/include/svn_xml.h URL: http://svn.apache.org/viewvc/subversion/branches/1.10.x/subversion/include/svn_xml.h?rev=1821587&r1=1821586&r2=1821587&view=diff ============================================================================== --- subversion/branches/1.10.x/subversion/include/svn_xml.h (original) +++ subversion/branches/1.10.x/subversion/include/svn_xml.h Fri Jan 19 04:00:07 2018 @@ -175,7 +175,7 @@ typedef void (*svn_xml_char_data)(void * * but some internal structures may be allocated out of pool. Use * svn_xml_free_parser() to free all memory used by the parser. * - * Since Subversion 1.10 parser will be freed automatically on pool + * @since Since Subversion 1.10 parser will be freed automatically on pool * cleanup or by svn_xml_free_parser() call. */ svn_xml_parser_t *