diff options
author | Stephan Bergmann <sbergman@redhat.com> | 2012-09-17 14:45:47 +0200 |
---|---|---|
committer | Stephan Bergmann <sbergman@redhat.com> | 2012-09-17 14:45:47 +0200 |
commit | 576ba0c0c082dfe50c4b97292093b833443c3756 (patch) | |
tree | 451906680af869a41802dc44c2f6bc6c82bc3753 /sal/inc/osl/interlck.h | |
parent | afbc57927854c423e12206c048bbe7c285a4d9a6 (diff) |
Some comment clean up
Change-Id: I33fbe68b17e9a1c457b37c6d81619f2df67fbe8d
Diffstat (limited to 'sal/inc/osl/interlck.h')
-rw-r--r-- | sal/inc/osl/interlck.h | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/sal/inc/osl/interlck.h b/sal/inc/osl/interlck.h index f8cd56e6e72b..792ea55051d9 100644 --- a/sal/inc/osl/interlck.h +++ b/sal/inc/osl/interlck.h @@ -41,50 +41,51 @@ extern "C" { typedef sal_Int32 oslInterlockedCount; /** Increments the count variable addressed by pCount. - @param pCount Address of counter variable - @return The result of the operation is zero, the value of the count variable. + @param pCount Address of count variable + @return The adjusted value of the count variable. */ SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_incrementInterlockedCount(oslInterlockedCount* pCount); /** Decrement the count variable addressed by pCount. - @param pCount Address of counter variable - @return The result of the operation is the new value is of the count variable. + @param pCount Address of count variable + @return The adjusted value of the count variable. */ SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_decrementInterlockedCount(oslInterlockedCount* pCount); -/** Increments the count variable addressed by pCount. - @param pCount Address of counter variable - @return The result of the operation is zero, the value of the count variable. -*/ - /// @cond INTERNAL /** Increments the count variable addressed by p. - @param p Address of counter variable + @attention This functionality should only be used internally within LibreOffice. + @param p Address of count variable @return The adjusted value of the count variable. + + @since LibreOffice 3.7 */ #if defined( HAVE_GCC_BUILTIN_ATOMIC ) # define osl_atomic_increment(p) __sync_add_and_fetch((p), 1) #else -# define osl_atomic_increment(p) osl_incrementInterlockedCount(p) +# define osl_atomic_increment(p) osl_incrementInterlockedCount((p)) #endif /** Decrement the count variable addressed by p. - @param p Address of counter variable + @attention This functionality should only be used internally within LibreOffice. + @param p Address of count variable @return The adjusted value of the count variable. + + @since LibreOffice 3.7 */ #if defined( HAVE_GCC_BUILTIN_ATOMIC ) # define osl_atomic_decrement(p) __sync_sub_and_fetch((p), 1) #else -# define osl_atomic_decrement(p) osl_decrementInterlockedCount(p) +# define osl_atomic_decrement(p) osl_decrementInterlockedCount((p)) #endif /// @endcond |