Author: julianfoad
Date: Tue Dec 18 02:03:04 2012
New Revision: 1423249
URL: http://svn.apache.org/viewvc?rev=1423249&view=rev
Log:
Use the '#' prefix or '()' suffix consistently instead of '@ref' in Doxygen
mark-up.
* subversion/include/private/svn_mutex.h,
subversion/include/private/svn_named_atomic.h,
subversion/include/svn_delta.h,
subversion/include/svn_io.h,
subversion/include/svn_pools.h
Tweak doc string mark-up.
Modified:
subversion/trunk/subversion/include/private/svn_mutex.h
subversion/trunk/subversion/include/private/svn_named_atomic.h
subversion/trunk/subversion/include/svn_delta.h
subversion/trunk/subversion/include/svn_io.h
subversion/trunk/subversion/include/svn_pools.h
Modified: subversion/trunk/subversion/include/private/svn_mutex.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_mutex.h?rev=1423249&r1=1423248&r2=1423249&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_mutex.h (original)
+++ subversion/trunk/subversion/include/private/svn_mutex.h Tue Dec 18 02:03:04
2012
@@ -57,8 +57,8 @@ typedef void svn_mutex__t;
/** Initialize the @a *mutex. If @a mutex_required is TRUE, the mutex will
* actually be created with a lifetime defined by @a result_pool. Otherwise,
- * the pointer will be set to @c NULL and @ref svn_mutex__lock as well as
- * @ref svn_mutex__unlock will be no-ops.
+ * the pointer will be set to @c NULL and svn_mutex__lock() as well as
+ * svn_mutex__unlock() will be no-ops.
*
* If threading is not supported by APR, this function is a no-op.
*/
@@ -67,27 +67,27 @@ svn_mutex__init(svn_mutex__t **mutex,
svn_boolean_t mutex_required,
apr_pool_t *result_pool);
-/** Acquire the @a mutex, if that has been enabled in @ref svn_mutex__init.
- * Make sure to call @ref svn_mutex__unlock some time later in the same
+/** Acquire the @a mutex, if that has been enabled in svn_mutex__init().
+ * Make sure to call svn_mutex__unlock() some time later in the same
* thread to release the mutex again. Recursive locking are not supported.
*
- * @note You should use @ref SVN_MUTEX__WITH_LOCK instead of explicit lock
+ * @note You should use #SVN_MUTEX__WITH_LOCK instead of explicit lock
* aquisition and release.
*/
svn_error_t *
svn_mutex__lock(svn_mutex__t *mutex);
-/** Release the @a mutex, previously acquired using @ref svn_mutex__lock
- * that has been enabled in @ref svn_mutex__init.
+/** Release the @a mutex, previously acquired using svn_mutex__lock()
+ * that has been enabled in svn_mutex__init().
*
* Since this is often used as part of the calling function's exit
* sequence, we accept that function's current return code in @a err.
- * If it is not @ref SVN_NO_ERROR, it will be used as the return value -
+ * If it is not #SVN_NO_ERROR, it will be used as the return value -
* irrespective of the possible internal failures during unlock. If @a err
- * is @ref SVN_NO_ERROR, internal failures of this function will be
+ * is #SVN_NO_ERROR, internal failures of this function will be
* reported in the return value.
*
- * @note You should use @ref SVN_MUTEX__WITH_LOCK instead of explicit lock
+ * @note You should use #SVN_MUTEX__WITH_LOCK instead of explicit lock
* aquisition and release.
*/
svn_error_t *
@@ -96,7 +96,7 @@ svn_mutex__unlock(svn_mutex__t *mutex,
/** Aquires the @a mutex, executes the expression @a expr and finally
* releases the @a mutex. If any of these steps fail, the function using
- * this macro will return an @ref svn_error_t. This macro guarantees that
+ * this macro will return an #svn_error_t. This macro guarantees that
* the @a mutex will always be unlocked again if it got locked successfully
* by the first step.
*
Modified: subversion/trunk/subversion/include/private/svn_named_atomic.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_named_atomic.h?rev=1423249&r1=1423248&r2=1423249&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_named_atomic.h (original)
+++ subversion/trunk/subversion/include/private/svn_named_atomic.h Tue Dec 18
02:03:04 2012
@@ -100,7 +100,7 @@ svn_atomic_namespace__cleanup(const char
* be set to @c NULL. Otherwise, a new atomic will be created, its value
* set to 0 and the access structure be returned in @a *atomic.
*
- * Note that @a name must not exceed @ref SVN_NAMED_ATOMIC__MAX_NAME_LENGTH
+ * Note that @a name must not exceed #SVN_NAMED_ATOMIC__MAX_NAME_LENGTH
* characters and an error will be returned if the specified name is longer
* than supported.
*
Modified: subversion/trunk/subversion/include/svn_delta.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_delta.h?rev=1423249&r1=1423248&r2=1423249&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_delta.h (original)
+++ subversion/trunk/subversion/include/svn_delta.h Tue Dec 18 02:03:04 2012
@@ -368,7 +368,7 @@ svn_txdelta_md5_digest(svn_txdelta_strea
* @a source and @a target are both readable generic streams. When we call
* svn_txdelta_next_window() on @a *stream, it will read from @a source and
* @a target to gather as much data as it needs. If @a calculate_checksum
- * is set, you may call @ref svn_txdelta_md5_digest to get an MD5 checksum
+ * is set, you may call svn_txdelta_md5_digest() to get an MD5 checksum
* for @a target.
*
* Do any necessary allocation in a sub-pool of @a pool.
Modified: subversion/trunk/subversion/include/svn_io.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=1423249&r1=1423248&r2=1423249&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Tue Dec 18 02:03:04 2012
@@ -724,7 +724,7 @@ svn_io_file_lock2(const char *lock_file,
* is not available: throw an error instead.
*
* Lock will be automatically released when @a pool is cleared or destroyed.
- * You may also explicitly call @ref svn_io_unlock_open_file.
+ * You may also explicitly call svn_io_unlock_open_file().
* Use @a pool for memory allocations. @a pool must be the pool that
* @a lockfile_handle has been created in or one of its sub-pools.
*
Modified: subversion/trunk/subversion/include/svn_pools.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_pools.h?rev=1423249&r1=1423248&r2=1423249&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_pools.h (original)
+++ subversion/trunk/subversion/include/svn_pools.h Tue Dec 18 02:03:04 2012
@@ -87,7 +87,7 @@ svn_pool_create_ex_debug(pool, allocator
#define svn_pool_destroy apr_pool_destroy
/** Return a new allocator. This function limits the unused memory in the
- * new allocator to @ref SVN_ALLOCATOR_RECOMMENDED_MAX_FREE and ensures
+ * new allocator to #SVN_ALLOCATOR_RECOMMENDED_MAX_FREE and ensures
* proper synchronization if the allocator is used by multiple threads.
*
* If your application uses multiple threads, creating a separate allocator
