Author: julianfoad
Date: Wed May 11 19:00:03 2011
New Revision: 1102021
URL: http://svn.apache.org/viewvc?rev=1102021&view=rev
Log:
* subversion/libsvn_ra/ra_loader.h
(svn_ra__vtable_t): Cross-reference to where each method is documented.
Modified:
subversion/trunk/subversion/libsvn_ra/ra_loader.h
Modified: subversion/trunk/subversion/libsvn_ra/ra_loader.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_ra/ra_loader.h?rev=1102021&r1=1102020&r2=1102021&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_ra/ra_loader.h (original)
+++ subversion/trunk/subversion/libsvn_ra/ra_loader.h Wed May 11 19:00:03 2011
@@ -51,6 +51,7 @@ typedef struct svn_ra__vtable_t {
/* Implementations of the public API functions. */
+ /* See svn_ra_open4(). */
/* All fields in SESSION, except priv, have been initialized by the
time this is called. SESSION->priv may be set by this function. */
svn_error_t *(*open_session)(svn_ra_session_t *session,
@@ -60,20 +61,25 @@ typedef struct svn_ra__vtable_t {
void *callback_baton,
apr_hash_t *config,
apr_pool_t *pool);
+ /* See svn_ra_reparent(). */
/* URL is guaranteed to have what get_repos_root() returns as a prefix. */
svn_error_t *(*reparent)(svn_ra_session_t *session,
const char *url,
apr_pool_t *pool);
+ /* See svn_ra_get_session_url(). */
svn_error_t *(*get_session_url)(svn_ra_session_t *session,
const char **url,
apr_pool_t *pool);
+ /* See svn_ra_get_latest_revnum(). */
svn_error_t *(*get_latest_revnum)(svn_ra_session_t *session,
svn_revnum_t *latest_revnum,
apr_pool_t *pool);
+ /* See svn_ra_get_dated_revision(). */
svn_error_t *(*get_dated_revision)(svn_ra_session_t *session,
svn_revnum_t *revision,
apr_time_t tm,
apr_pool_t *pool);
+ /* See svn_ra_change_rev_prop2(). */
svn_error_t *(*change_rev_prop)(svn_ra_session_t *session,
svn_revnum_t rev,
const char *name,
@@ -81,15 +87,18 @@ typedef struct svn_ra__vtable_t {
const svn_string_t *value,
apr_pool_t *pool);
+ /* See svn_ra_rev_proplist(). */
svn_error_t *(*rev_proplist)(svn_ra_session_t *session,
svn_revnum_t rev,
apr_hash_t **props,
apr_pool_t *pool);
+ /* See svn_ra_rev_prop(). */
svn_error_t *(*rev_prop)(svn_ra_session_t *session,
svn_revnum_t rev,
const char *name,
svn_string_t **value,
apr_pool_t *pool);
+ /* See svn_ra_get_commit_editor3(). */
svn_error_t *(*get_commit_editor)(svn_ra_session_t *session,
const svn_delta_editor_t **editor,
void **edit_baton,
@@ -99,6 +108,7 @@ typedef struct svn_ra__vtable_t {
apr_hash_t *lock_tokens,
svn_boolean_t keep_locks,
apr_pool_t *pool);
+ /* See svn_ra_get_file(). */
svn_error_t *(*get_file)(svn_ra_session_t *session,
const char *path,
svn_revnum_t revision,
@@ -106,6 +116,7 @@ typedef struct svn_ra__vtable_t {
svn_revnum_t *fetched_rev,
apr_hash_t **props,
apr_pool_t *pool);
+ /* See svn_ra_get_dir2(). */
svn_error_t *(*get_dir)(svn_ra_session_t *session,
apr_hash_t **dirents,
svn_revnum_t *fetched_rev,
@@ -114,6 +125,7 @@ typedef struct svn_ra__vtable_t {
svn_revnum_t revision,
apr_uint32_t dirent_fields,
apr_pool_t *pool);
+ /* See svn_ra_get_mergeinfo2(). */
svn_error_t *(*get_mergeinfo)(svn_ra_session_t *session,
svn_mergeinfo_catalog_t *mergeinfo,
const apr_array_header_t *paths,
@@ -122,6 +134,7 @@ typedef struct svn_ra__vtable_t {
svn_boolean_t *validate_inherited_mergeinfo,
svn_boolean_t include_merged_revisions,
apr_pool_t *pool);
+ /* See svn_ra_do_update2(). */
svn_error_t *(*do_update)(svn_ra_session_t *session,
const svn_ra_reporter3_t **reporter,
void **report_baton,
@@ -132,6 +145,7 @@ typedef struct svn_ra__vtable_t {
const svn_delta_editor_t *update_editor,
void *update_baton,
apr_pool_t *pool);
+ /* See svn_ra_do_switch2(). */
svn_error_t *(*do_switch)(svn_ra_session_t *session,
const svn_ra_reporter3_t **reporter,
void **report_baton,
@@ -142,6 +156,7 @@ typedef struct svn_ra__vtable_t {
const svn_delta_editor_t *switch_editor,
void *switch_baton,
apr_pool_t *pool);
+ /* See svn_ra_do_status2(). */
svn_error_t *(*do_status)(svn_ra_session_t *session,
const svn_ra_reporter3_t **reporter,
void **report_baton,
@@ -151,6 +166,7 @@ typedef struct svn_ra__vtable_t {
const svn_delta_editor_t *status_editor,
void *status_baton,
apr_pool_t *pool);
+ /* See svn_ra_do_diff3(). */
svn_error_t *(*do_diff)(svn_ra_session_t *session,
const svn_ra_reporter3_t **reporter,
void **report_baton,
@@ -163,6 +179,7 @@ typedef struct svn_ra__vtable_t {
const svn_delta_editor_t *diff_editor,
void *diff_baton,
apr_pool_t *pool);
+ /* See svn_ra_get_log2(). */
svn_error_t *(*get_log)(svn_ra_session_t *session,
const apr_array_header_t *paths,
svn_revnum_t start,
@@ -175,28 +192,34 @@ typedef struct svn_ra__vtable_t {
svn_log_entry_receiver_t receiver,
void *receiver_baton,
apr_pool_t *pool);
+ /* See svn_ra_check_path(). */
svn_error_t *(*check_path)(svn_ra_session_t *session,
const char *path,
svn_revnum_t revision,
svn_node_kind_t *kind,
apr_pool_t *pool);
+ /* See svn_ra_stat(). */
svn_error_t *(*stat)(svn_ra_session_t *session,
const char *path,
svn_revnum_t revision,
svn_dirent_t **dirent,
apr_pool_t *pool);
+ /* See svn_ra_get_uuid2(). */
svn_error_t *(*get_uuid)(svn_ra_session_t *session,
const char **uuid,
apr_pool_t *pool);
+ /* See svn_ra_get_repos_root2(). */
svn_error_t *(*get_repos_root)(svn_ra_session_t *session,
const char **url,
apr_pool_t *pool);
+ /* See svn_ra_get_locations(). */
svn_error_t *(*get_locations)(svn_ra_session_t *session,
apr_hash_t **locations,
const char *path,
svn_revnum_t peg_revision,
const apr_array_header_t *location_revisions,
apr_pool_t *pool);
+ /* See svn_ra_get_location_segments(). */
svn_error_t *(*get_location_segments)(svn_ra_session_t *session,
const char *path,
svn_revnum_t peg_revision,
@@ -205,6 +228,7 @@ typedef struct svn_ra__vtable_t {
svn_location_segment_receiver_t rcvr,
void *receiver_baton,
apr_pool_t *pool);
+ /* See svn_ra_get_file_revs2(). */
svn_error_t *(*get_file_revs)(svn_ra_session_t *session,
const char *path,
svn_revnum_t start,
@@ -213,6 +237,7 @@ typedef struct svn_ra__vtable_t {
svn_file_rev_handler_t handler,
void *handler_baton,
apr_pool_t *pool);
+ /* See svn_ra_lock(). */
svn_error_t *(*lock)(svn_ra_session_t *session,
apr_hash_t *path_revs,
const char *comment,
@@ -220,21 +245,25 @@ typedef struct svn_ra__vtable_t {
svn_ra_lock_callback_t lock_func,
void *lock_baton,
apr_pool_t *pool);
+ /* See svn_ra_unlock(). */
svn_error_t *(*unlock)(svn_ra_session_t *session,
apr_hash_t *path_tokens,
svn_boolean_t force,
svn_ra_lock_callback_t lock_func,
void *lock_baton,
apr_pool_t *pool);
+ /* See svn_ra_get_lock(). */
svn_error_t *(*get_lock)(svn_ra_session_t *session,
svn_lock_t **lock,
const char *path,
apr_pool_t *pool);
+ /* See svn_ra_get_locks2(). */
svn_error_t *(*get_locks)(svn_ra_session_t *session,
apr_hash_t **locks,
const char *path,
svn_depth_t depth,
apr_pool_t *pool);
+ /* See svn_ra_replay(). */
svn_error_t *(*replay)(svn_ra_session_t *session,
svn_revnum_t revision,
svn_revnum_t low_water_mark,
@@ -242,10 +271,12 @@ typedef struct svn_ra__vtable_t {
const svn_delta_editor_t *editor,
void *edit_baton,
apr_pool_t *pool);
+ /* See svn_ra_has_capability(). */
svn_error_t *(*has_capability)(svn_ra_session_t *session,
svn_boolean_t *has,
const char *capability,
apr_pool_t *pool);
+ /* See svn_ra_replay_range(). */
svn_error_t *
(*replay_range)(svn_ra_session_t *session,
svn_revnum_t start_revision,
@@ -256,6 +287,7 @@ typedef struct svn_ra__vtable_t {
svn_ra_replay_revfinish_callback_t revfinish_func,
void *replay_baton,
apr_pool_t *pool);
+ /* See svn_ra_get_deleted_rev(). */
svn_error_t *(*get_deleted_rev)(svn_ra_session_t *session,
const char *path,
svn_revnum_t peg_revision,
