You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by ju...@apache.org on 2019/03/01 14:55:46 UTC
svn commit: r1854598 - in /subversion/trunk/subversion/include:
private/svn_client_private.h svn_client.h svn_delta.h
Author: julianfoad
Date: Fri Mar 1 14:55:46 2019
New Revision: 1854598
URL: http://svn.apache.org/viewvc?rev=1854598&view=rev
Log:
Tweak API documentation, reviewing API changes since 1.11.
Fix missing 'deprecated' tags, Doxygen mark-up, etc.
Modified:
subversion/trunk/subversion/include/private/svn_client_private.h
subversion/trunk/subversion/include/svn_client.h
subversion/trunk/subversion/include/svn_delta.h
Modified: subversion/trunk/subversion/include/private/svn_client_private.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_client_private.h?rev=1854598&r1=1854597&r2=1854598&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_client_private.h (original)
+++ subversion/trunk/subversion/include/private/svn_client_private.h Fri Mar 1 14:55:46 2019
@@ -385,15 +385,15 @@ svn_client__get_diff_summarize_callbacks
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
-/* Copy a directory tree or a file (according to KIND) from SRC_URL @ SRC_REV,
- * to DST_ABSPATH in a WC.
+/** Copy a directory tree or a file (according to @a kind) from @a src_url at
+ * @a src_rev, to @a dst_abspath in a WC.
*
- * The caller should be holding a WC write lock that allows DST_ABSPATH to
- * be created, such as on the parent of DST_ABSPATH.
+ * The caller should be holding a WC write lock that allows @a dst_abspath to
+ * be created, such as on the parent of @a dst_abspath.
*
* If not same repositories, then remove any svn:mergeinfo property.
*
- * Use RA_SESSION to fetch the data. The session may point to any URL
+ * Use @a ra_session to fetch the data. The session may point to any URL
* within the source repository.
*
* This API does not process any externals definitions that may be present
@@ -409,15 +409,15 @@ svn_client__repos_to_wc_copy_internal(sv
svn_client_ctx_t *ctx,
apr_pool_t *scratch_pool);
-/* Copy a directory tree or a file (according to KIND) from SRC_URL @ SRC_REV,
- * to DST_ABSPATH in a WC.
+/** Copy a directory tree or a file (according to @a kind) from @a src_url at
+ * @a src_rev, to @a dst_abspath in a WC.
*
- * The caller should be holding a WC write lock that allows DST_ABSPATH to
- * be created, such as on the parent of DST_ABSPATH.
+ * The caller should be holding a WC write lock that allows @a dst_abspath to
+ * be created, such as on the parent of @a dst_abspath.
*
* If not same repositories, then remove any svn:mergeinfo property.
*
- * Use RA_SESSION to fetch the data. The session may point to a different
+ * Use @a ra_session to fetch the data. The session may point to a different
* URL after returning.
*
* This API does not process any externals definitions that may be present
@@ -445,7 +445,7 @@ svn_client__repos_to_wc_copy_by_editor(s
* Send notifications via @a notify_func / @a notify_baton.
* ### INCOMPLETE
*
- * RA_SESSION is used to fetch the original content for copies.
+ * @a ra_session is used to fetch the original content for copies.
*
* Ignore changes to non-regular property (entry-props, DAV/WC-props).
*
@@ -540,7 +540,7 @@ svn_client__wc_replay(const char *src_wc
*
* Edit the WC at @a dst_wc_abspath, applying those modifications to the
* current working state to produce a new working state.
- *
+ *
* The source and destination may be in the same WC or in different WCs.
*/
svn_error_t *
Modified: subversion/trunk/subversion/include/svn_client.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_client.h?rev=1854598&r1=1854597&r2=1854598&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_client.h (original)
+++ subversion/trunk/subversion/include/svn_client.h Fri Mar 1 14:55:46 2019
@@ -2998,6 +2998,7 @@ svn_client_blame6(svn_revnum_t *start_re
*
* @since New in 1.7.
*/
+SVN_DEPRECATED
svn_error_t *
svn_client_blame5(const char *path_or_url,
const svn_opt_revision_t *peg_revision,
@@ -4633,10 +4634,10 @@ typedef enum svn_client_conflict_option_
svn_client_conflict_option_sibling_move_dir_merge, /**< @since New in 1.11. */
/* Options for local move vs incoming move on merge. */
- svn_client_conflict_option_both_moved_file_merge, /*< since New in 1.12 */
- svn_client_conflict_option_both_moved_file_move_merge, /*< since New in 1.12 */
- svn_client_conflict_option_both_moved_dir_merge, /*< since New in 1.12 */
- svn_client_conflict_option_both_moved_dir_move_merge, /*< since New in 1.12 */
+ svn_client_conflict_option_both_moved_file_merge, /*< @since New in 1.12 */
+ svn_client_conflict_option_both_moved_file_move_merge, /*< @since New in 1.12 */
+ svn_client_conflict_option_both_moved_dir_merge, /*< @since New in 1.12 */
+ svn_client_conflict_option_both_moved_dir_move_merge, /*< @since New in 1.12 */
} svn_client_conflict_option_id_t;
/**
@@ -7155,7 +7156,7 @@ svn_client__shelf_save_new_version3(svn_
*
* Leave the shelf's log message and other revprops unchanged.
*
- * Any #svn_client_shelf_version_t object that refers to a deleted version
+ * Any #svn_client__shelf_version_t object that refers to a deleted version
* will become invalid: attempting to use it will give undefined behaviour.
* The given @a shelf_version will remain valid.
*
@@ -7195,7 +7196,7 @@ svn_client__shelf_get_newest_version(svn
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
-/** Return in @a versions_p an array of (#svn_client_shelf_version_t *)
+/** Return in @a versions_p an array of (#svn_client__shelf_version_t *)
* containing all versions of @a shelf.
*
* The versions will be in chronological order, oldest to newest.
Modified: subversion/trunk/subversion/include/svn_delta.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_delta.h?rev=1854598&r1=1854597&r2=1854598&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_delta.h (original)
+++ subversion/trunk/subversion/include/svn_delta.h Fri Mar 1 14:55:46 2019
@@ -1382,6 +1382,7 @@ svn_delta_path_driver3(const svn_delta_e
* @since New in 1.8. Before 1.12, paths sent to the callback were the
* exact paths passed in @a paths.
*/
+SVN_DEPRECATED
svn_error_t *
svn_delta_path_driver2(const svn_delta_editor_t *editor,
void *edit_baton,