svn commit: r1920914 - in /subversion/branches/windows-shared-ra-modules/subversion: libsvn_ra_local/ra_init.h libsvn_ra_serf/ra_init.h libsvn_ra_svn/ra_init.h

Author: rinrab
Date: Wed Sep 25 15:57:37 2024
New Revision: 1920914

URL: http://svn.apache.org/viewvc?rev=1920914&view=rev
Log:
On the 'windows-shared-ra-modules' branch: Add docstrings to the functions
declared in ra_init.h of each RA module.

* subversion/libsvn_ra_local/ra_init.h,
  subversion/libsvn_ra_serf/ra_init.h,
  subversion/libsvn_ra_svn/ra_init.h
  (svn_ra_local__init, svn_ra_local__deprecated_init,
   svn_ra_serf__init, svn_ra_serf__deprecated_init,
   svn_ra_svn__init, svn_ra_svn__deprecated_init): Document functions.

Modified:
    subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_local/ra_init.h
    subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_serf/ra_init.h
    subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_svn/ra_init.h

Modified: subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_local/ra_init.h
URL: http://svn.apache.org/viewvc/subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_local/ra_init.h?rev=1920914&r1=1920913&r2=1920914&view=diff
==============================================================================
--- subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_local/ra_init.h (original)
+++ subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_local/ra_init.h Wed Sep 25 15:57:37 2024
@@ -26,13 +26,25 @@
 
 #include "../libsvn_ra/ra_loader.h"
 
+/**
+ * Initialize libsvn_ra_local library.
+ *
+ * Use @a pool for temporary allocations.
+ *
+ * @return RA module version-@a loader_version.
+ * @return RA vtable-@a vtable.
+ */
 svn_error_t *svn_ra_local__init(const svn_version_t *loader_version,
                                 const svn_ra__vtable_t **vtable,
                                 apr_pool_t *pool);
 
-/** Initialize libsvn_ra_local.
+/**
+ * Compatibility wrapper around svn_ra_local__init.
+ *
+ * Use @a pool for temporary allocations.
  *
- * @deprecated Provided for backward compatibility with the 1.1 API. */
+ * @return @a hash with the scheme as the key and the vtable as the value.
+ */
 svn_error_t *svn_ra_local__deprecated_init(int abi_version,
                                            apr_pool_t *pool,
                                            apr_hash_t *hash);

Modified: subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_serf/ra_init.h
URL: http://svn.apache.org/viewvc/subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_serf/ra_init.h?rev=1920914&r1=1920913&r2=1920914&view=diff
==============================================================================
--- subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_serf/ra_init.h (original)
+++ subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_serf/ra_init.h Wed Sep 25 15:57:37 2024
@@ -26,11 +26,25 @@
 
 #include "../libsvn_ra/ra_loader.h"
 
+/**
+ * Initialize libsvn_ra_serf library.
+ *
+ * Use @a pool for temporary allocations.
+ *
+ * @return RA module version-@a loader_version.
+ * @return RA vtable-@a vtable.
+ */
 svn_error_t *svn_ra_serf__init(const svn_version_t *loader_version,
                                const svn_ra__vtable_t **vtable,
                                apr_pool_t *pool);
 
-/* Non-deprecated wrapper around svn_ra_serf_init. */
+/**
+ * Compatibility wrapper around svn_ra_serf__init.
+ *
+ * Use @a pool for temporary allocations.
+ *
+ * @return @a hash with the scheme as the key and the vtable as the value.
+ */
 svn_error_t *svn_ra_serf__deprecated_init(int abi_version,
                                           apr_pool_t *pool,
                                           apr_hash_t *hash);

Modified: subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_svn/ra_init.h
URL: http://svn.apache.org/viewvc/subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_svn/ra_init.h?rev=1920914&r1=1920913&r2=1920914&view=diff
==============================================================================
--- subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_svn/ra_init.h (original)
+++ subversion/branches/windows-shared-ra-modules/subversion/libsvn_ra_svn/ra_init.h Wed Sep 25 15:57:37 2024
@@ -26,11 +26,25 @@
 
 #include "../libsvn_ra/ra_loader.h"
 
+/**
+ * Initialize libsvn_ra_svn library.
+ *
+ * Use @a pool for temporary allocations.
+ *
+ * @return RA module version-@a loader_version.
+ * @return RA vtable-@a vtable.
+ */
 svn_error_t *svn_ra_svn__init(const svn_version_t *loader_version,
                               const svn_ra__vtable_t **vtable,
                               apr_pool_t *pool);
 
-/* Non-deprecated wrapper around svn_ra_svn_init. */
+/**
+ * Compatibility wrapper around svn_ra_svn__init.
+ *
+ * Use @a pool for temporary allocations.
+ *
+ * @return @a hash with the scheme as the key and the vtable as the value.
+ */
 svn_error_t *svn_ra_svn__deprecated_init(int abi_version,
                                          apr_pool_t *pool,
                                          apr_hash_t *hash);