include/osl/mutex.hxx | 4 +++-
include/osl/profile.hxx | 3 ++-
include/osl/security.h | 1 -
include/osl/socket.h | 3 ++-
include/osl/socket_decl.hxx | 4 +++-
include/rtl/alloc.h | 20 +++++++++-----------
include/rtl/cipher.h | 4 +++-
include/rtl/digest.h | 1 -
include/rtl/random.h | 1 -
include/rtl/ustring.h | 1 -
10 files changed, 22 insertions(+), 20 deletions(-)
New commits:
commit 18dacc47b212bec440a5f729a2787aa91db89b44
Author: Chris Sherlock <chris.sherloc...@gmail.com>
AuthorDate: Sun Jul 3 01:28:18 2022 +1000
Commit: Stephan Bergmann <sberg...@redhat.com>
CommitDate: Tue Jul 5 12:36:32 2022 +0200
sal: fix invalid doxygen
Change-Id: Ib26a695c88d02a0ce5a3c9974fae9f88d8ae89ad
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/136783
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sberg...@redhat.com>
diff --git a/include/osl/mutex.hxx b/include/osl/mutex.hxx
index 96bfd3e02178..481a2bb55002 100644
--- a/include/osl/mutex.hxx
+++ b/include/osl/mutex.hxx
@@ -36,7 +36,9 @@ namespace osl
public:
/** Create a mutex.
- @return 0 if the mutex could not be created, otherwise a handle to
the mutex.
+
+ The mutex value is 0 if it could not be created, otherwise a
handle to the mutex.
+
@see ::osl_createMutex()
*/
Mutex()
diff --git a/include/osl/profile.hxx b/include/osl/profile.hxx
index ec75e3ce3470..e83fef0c665c 100644
--- a/include/osl/profile.hxx
+++ b/include/osl/profile.hxx
@@ -48,7 +48,8 @@ namespace osl {
public:
/** Open or create a configuration profile.
- @retval 0 if the profile could not be created, otherwise a handle
to the profile.
+
+ Sets a handle to the profile, otherwise if the profile could not
be opened then throw an exception.
*/
Profile(const rtl::OUString & strProfileName, oslProfileOption Options
= Profile_DEFAULT )
{
diff --git a/include/osl/security.h b/include/osl/security.h
index 56674027ea19..9c56f20971f4 100644
--- a/include/osl/security.h
+++ b/include/osl/security.h
@@ -162,7 +162,6 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_loadUserProfile(
/** Unload a User Profile
Implemented just for Windows
@param[in] Security previously fetch Security of the User
- @return nothing is returned!
*/
SAL_DLLPUBLIC void SAL_CALL osl_unloadUserProfile(
diff --git a/include/osl/socket.h b/include/osl/socket.h
index 7f87da312d4e..474860b14701 100644
--- a/include/osl/socket.h
+++ b/include/osl/socket.h
@@ -832,7 +832,8 @@ SAL_DLLPUBLIC void SAL_CALL osl_destroyHostAddr(oslHostAddr
Addr);
/** Get the hostname member of Addr.
- @return The hostname or 0 upon failure.
+ @param Addr address for host name
+ @param strHostname The host name or 0 upon failure.
*/
SAL_DLLPUBLIC void SAL_CALL osl_getHostnameOfHostAddr(const oslHostAddr Addr,
rtl_uString **strHostname);
diff --git a/include/osl/socket_decl.hxx b/include/osl/socket_decl.hxx
index de6442b273b2..1ff2bababa29 100644
--- a/include/osl/socket_decl.hxx
+++ b/include/osl/socket_decl.hxx
@@ -174,8 +174,10 @@ namespace osl
static inline ::rtl::OUString SAL_CALL getLocalHostname(
oslSocketResult *pResult = NULL);
/** Tries to find an address for a host.
+
@see osl_resolveHostname()
- @return A new created socket-address or 0 if the name could not be
found.
+ @param strHostName hostname
+ @param Addr A newly created socket-address or 0 if the name could
not be found.
*/
static inline void SAL_CALL resolveHostname(
const ::rtl::OUString & strHostName , SocketAddr & Addr );
diff --git a/include/rtl/alloc.h b/include/rtl/alloc.h
index 79a94704c222..4ce01cf1bcb4 100644
--- a/include/rtl/alloc.h
+++ b/include/rtl/alloc.h
@@ -68,8 +68,10 @@ SAL_DLLPUBLIC void * SAL_CALL rtl_reallocateMemory (
/** Free memory.
+
+ Memory is released, and the pointer is invalidated.
+
@param[in] Ptr pointer to the previously allocated memory.
- @return none. Memory is released. Ptr is invalid.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_freeMemory (
void * Ptr
@@ -103,10 +105,12 @@ SAL_DLLPUBLIC void SAL_CALL rtl_secureZeroMemory (
/** Zero and free memory.
+
+ Memory is zero'ed with rtl_secureZeroMemory() and released.
+ The original pointer is no longer valid.
+
@param[in] Ptr pointer to the previously allocated memory.
@param[in] Bytes memory size.
- @return none. Memory is zero'ed with rtl_secureZeroMemory() and released.
- Ptr is invalid.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_freeZeroMemory (
void * Ptr,
@@ -136,8 +140,9 @@ SAL_DLLPUBLIC void* SAL_CALL rtl_allocateAlignedMemory (
/** Free memory allocated with rtl_allocateAlignedMemory().
+ Memory is released, and the pointer invalidated.
+
@param[in] Ptr pointer to the previously allocated memory.
- @return none. Memory is released. Ptr is invalid.
@since LibreOffice 4.3
*/
@@ -179,7 +184,6 @@ SAL_DLLPUBLIC rtl_arena_type * SAL_CALL rtl_arena_create (
/**
* @param[in] pArena the arena to destroy.
- * @return None
*
* @see rtl_arena_create()
*/
@@ -207,8 +211,6 @@ SAL_DLLPUBLIC void * SAL_CALL rtl_arena_alloc (
* @param[in] pAddr resource to free.
* @param[in] nBytes size of resource.
*
- * @return None.
- *
* @see rtl_arena_alloc()
*/
SAL_DLLPUBLIC void SAL_CALL rtl_arena_free (
@@ -257,8 +259,6 @@ SAL_DLLPUBLIC rtl_cache_type * SAL_CALL rtl_cache_create (
/**
* @param[in] pCache the cache to destroy.
*
- * @return None.
- *
* @see rtl_cache_create()
*/
SAL_DLLPUBLIC void SAL_CALL rtl_cache_destroy (
@@ -280,8 +280,6 @@ SAL_DLLPUBLIC void * SAL_CALL rtl_cache_alloc (
* @param[in] pCache cache from which object was allocated.
* @param[in] pObj object to free.
*
- * @return None.
- *
* @see rtl_cache_alloc()
*/
SAL_DLLPUBLIC void SAL_CALL rtl_cache_free (
diff --git a/include/rtl/cipher.h b/include/rtl/cipher.h
index ed718166c2b3..928f71ba973d 100644
--- a/include/rtl/cipher.h
+++ b/include/rtl/cipher.h
@@ -171,8 +171,10 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_decode (
) SAL_THROW_EXTERN_C();
/** Destroy a cipher handle.
+
+ Cipher handle destroyed and invalid.
+
@param[in] Cipher cipher handle to be destroyed.
- @return None. Cipher handle destroyed and invalid.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_cipher_destroy (
rtlCipher Cipher
diff --git a/include/rtl/digest.h b/include/rtl/digest.h
index bb2d4f8f074a..f649d8b594be 100644
--- a/include/rtl/digest.h
+++ b/include/rtl/digest.h
@@ -92,7 +92,6 @@ SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create (
/** Destroy a digest handle.
@post Digest handle destroyed and invalid.
@param[in] Digest digest handle to be destroyed.
- @return None.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroy (
rtlDigest Digest
diff --git a/include/rtl/random.h b/include/rtl/random.h
index af21139de566..cc7cf7943581 100644
--- a/include/rtl/random.h
+++ b/include/rtl/random.h
@@ -62,7 +62,6 @@ SAL_DLLPUBLIC rtlRandomPool SAL_CALL rtl_random_createPool
(void) SAL_THROW_EXTE
/** Destroy a Random Pool.
@param[in] Pool a Random Pool.
- @return none. Pool is invalid.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
rtlRandomPool Pool
diff --git a/include/rtl/ustring.h b/include/rtl/ustring.h
index 2371d9a5e8d7..e8d1283791ab 100644
--- a/include/rtl/ustring.h
+++ b/include/rtl/ustring.h
@@ -1345,7 +1345,6 @@ SAL_DLLPUBLIC void SAL_CALL
rtl_uString_newFromStr_WithLength(
@param[in] from the String to take the substring from.
@param[in] beginIndex the beginning index, inclusive.
@param[in] count the number of characters.
- @return the specified substring.
@since LibreOffice 4.0
*/
