osl: doxygen fixes for headers

Change-Id: I3f30b5ab985c2ff709116568905b941c5d50fd1a

include/osl/module.hxx

@@ -45,11 +45,8 @@ public:
         Similar to getUrlFromAddress, but use a function address to get URL of the Module.
         Use Function pointer as symbol address to conceal type conversion.
 
-        @param addr
-        [in] function address in oslGenericFunction format.
-
-        @param libraryUrl
-        [in|out] receives the URL of the module.
+        @param[in] addr            function address in oslGenericFunction format.
+        @param[in,out] libraryUrl  receives the URL of the module.
 
         @retval true on success
         @retval false can not get the URL from the specified function address or the parameter is invalid.
@@ -134,8 +131,7 @@ public:
         getFunctionSymbol is an alternative function for getSymbol.
         Use Function pointer as symbol address to conceal type conversion.
 
-        @param ustrFunctionSymbolName
-        [in] Function name to be looked up.
+        @param[in] ustrFunctionSymbolName  Function name to be looked up.
 
         @retval oslGenericFunction format function address on success
         @retval NULL lookup failed or parameter is somewhat invalid

include/osl/mutex.h

@@ -33,11 +33,13 @@ struct _oslMutexImpl;
 typedef struct _oslMutexImpl * oslMutex;
 
 /** Create a mutex.
+
     @return 0 if the mutex could not be created, otherwise a handle to the mutex.
 */
 SAL_DLLPUBLIC oslMutex SAL_CALL osl_createMutex(void);
 
 /** Release the OS-structures and free mutex data-structure.
+
     @param Mutex the mutex-handle
 */
 SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex);
@@ -49,18 +51,22 @@ SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex);
 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex);
 
 /** Try to acquire the mutex without blocking.
+
     @param Mutex handle to a created mutex.
+
     @retval False if it could not be acquired.
 */
 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex);
 
 /** Release the mutex.
+
     @param Mutex handle to a created mutex.
     @retval False if system-call fails.
 */
 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex);
 
 /** Returns a unique and global mutex.
+
     @return the global mutex.
 */
 SAL_DLLPUBLIC oslMutex * SAL_CALL osl_getGlobalMutex(void);

include/osl/pipe_decl.hxx

@@ -155,6 +155,7 @@ public:
     inline StreamPipe();
 
     /** Creates pipe as wrapper around the underlying oslPipe.
+
         @param Pipe
     */
     inline StreamPipe(oslPipe Pipe);
@@ -165,15 +166,17 @@ public:
     inline StreamPipe(const StreamPipe& Pipe);
 
     /** Creates a pipe.
-        @param strName
-        @param Options
+
+        @param[in] strName Pipe name
+        @param[in] Options Pipe options
     */
     inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options = osl_Pipe_OPEN);
 
     /** Creates a pipe.
-        @param strName
-        @param Options
-        @param rSec
+
+        @param[in] strName Pipe name
+        @param[in] Options Pipe options
+        @param[in] rSec    Security for the pipe
     */
     inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security &rSec );
 
@@ -184,7 +187,8 @@ public:
     /** Attaches the oslPipe to this object. If the object
         already was attached to an oslPipe, the old one will
         be closed and destroyed.
-        @param Pipe
+
+        @param[in] Pipe    Pipe to attach to this object
     */
     inline StreamPipe & SAL_CALL operator=(oslPipe Pipe);
 
@@ -194,39 +198,45 @@ public:
 
     /** Tries to receives BytesToRead data from the connected pipe,
 
-        @param pBuffer [out] Points to a buffer that will be filled with the received
-        data.
-        @param BytesToRead [in] The number of bytes to read. pBuffer must have at least
-        this size.
+        @param[out] pBuffer Points to a buffer that will be filled with the received
+                     data.
+        @param[in] BytesToRead The number of bytes to read. pBuffer must have at least
+                     this size.
+
         @return the number of received bytes.
     */
     inline sal_Int32 SAL_CALL recv(void* pBuffer, sal_Int32 BytesToRead) const;
 
     /** Tries to sends BytesToSend data from the connected pipe.
 
-        @param pBuffer [in] Points to a buffer that contains the send-data.
-        @param BytesToSend [in] The number of bytes to send. pBuffer must have at least
-        this size.
+        @param[in] pBuffer Points to a buffer that contains the send-data.
+        @param[in] BytesToSend The number of bytes to send. pBuffer must have at least
+                       this size.
+
         @return the number of transferred bytes.
     */
     inline sal_Int32 SAL_CALL send(const void* pBuffer, sal_Int32 BytesToSend) const;
 
     /** Retrieves n bytes from the stream and copies them into pBuffer.
         The method avoids incomplete reads due to packet boundaries.
-        @param pBuffer receives the read data.
-        @param n the number of bytes to read. pBuffer must be large enough
+
+        @param[in] pBuffer receives the read data.
+        @param[in] n the number of bytes to read. pBuffer must be large enough
         to hold the n bytes!
+
         @return the number of read bytes. The number will only be smaller than
-        n if an exceptional condition (e.g. connection closed) occurs.
+            n if an exceptional condition (e.g. connection closed) occurs.
     */
     inline sal_Int32 SAL_CALL read(void* pBuffer, sal_Int32 n) const;
 
     /** Writes n bytes from pBuffer to the stream. The method avoids
         incomplete writes due to packet boundaries.
-        @param pBuffer contains the data to be written.
-        @param n the number of bytes to write.
+
+        @param[in] pBuffer contains the data to be written.
+        @param[in] n the number of bytes to write.
+
         @return the number of written bytes. The number will only be smaller than
-        n if an exceptional condition (e.g. connection closed) occurs.
+            n if an exceptional condition (e.g. connection closed) occurs.
     */
     sal_Int32 SAL_CALL write(const void* pBuffer, sal_Int32 n) const;
 };

include/osl/profile.h

@@ -57,10 +57,10 @@ SAL_DLLPUBLIC oslProfile SAL_CALL osl_openProfile(
 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_closeProfile(
         oslProfile Profile) SAL_COLD;
 
-
 /** Deprecated API.
     @deprecated
 */
+
 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_flushProfile(
         oslProfile Profile) SAL_COLD;
 /** Deprecated API.
@@ -94,6 +94,7 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileString(
                                oslProfile Profile,
                                const sal_Char* pszSection, const sal_Char* pszEntry,
                                const sal_Char* pszString) SAL_COLD;
+
 /** Deprecated API.
     @deprecated
 */
@@ -101,6 +102,7 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileBool(
                              oslProfile Profile,
                              const sal_Char* pszSection, const sal_Char* pszEntry,
                              sal_Bool Value) SAL_COLD;
+
 /** Deprecated API.
     @deprecated
 */

include/osl/security_decl.hxx

@@ -21,7 +21,7 @@
 #define INCLUDED_OSL_SECURITY_DECL_HXX
 
 #include <rtl/ustring.hxx>
-#   include <osl/security.h>
+#include <osl/security.h>
 
 namespace osl
 {
@@ -42,8 +42,10 @@ public:
 
     /** get the security information for one user.
         The underlying operating system is asked for this information.
+
         @param[in] strName denotes the name of the user
         @param[in] strPasswd denotes the password of this user
+
         @retval True, if the specified user is known by the underlying operating system
         @retval False unknown user
     */
@@ -64,7 +66,7 @@ public:
         @param[in] strFileServer denotes the file server to login to
 
         @retval True if the specified user is known by the file server and they
-        could be connected
+            could be connected
         @retval False if the user is not known by the file server
     */
     inline bool SAL_CALL logonUser(const rtl::OUString & strName,
@@ -72,6 +74,7 @@ public:
                                        const rtl::OUString & strFileServer);
 
     /** get the ident of the logged in user.
+
         @param[out] strIdent is the OUString which returns the name
 
         @retval True if any user is successfully logged in
@@ -80,6 +83,7 @@ public:
     inline bool  SAL_CALL getUserIdent( rtl::OUString& strIdent) const;
 
     /** get the name of the logged in user.
+
         @param[out] strName is the OUString which returns the name
         @param[in] bIncludeDomain Include the Domain name (like "ORG\username"). Affects Windows only.
                                   This parameter is available since LibreOffice 5.2.
@@ -98,6 +102,7 @@ public:
     inline bool SAL_CALL getHomeDir( rtl::OUString& strDirectory) const;
 
     /** get the directory for configuration data of the logged in user.
+
         @param[out] strDirectory is the OUString which returns the directory name
 
         @retval True if any user is successfully logged in
@@ -106,6 +111,7 @@ public:
     inline bool SAL_CALL getConfigDir( rtl::OUString & strDirectory) const;
 
     /** Query if the user who is logged in has administrator rights.
+
         @retval True if the user has administrator rights
         @retval False if the user does not have admin rights
     */
@@ -114,7 +120,6 @@ public:
     /** Returns the underlying oslSecurity handle
      */
     inline oslSecurity getHandle() const;
-
 };
 
 }

include/osl/signal.h

@@ -73,7 +73,7 @@ typedef struct
 #   pragma pack(pop)
 #endif
 
-/** the function-ptr. representing the signal handler-function.
+/** The function-ptr representing the signal handler-function.
 */
 typedef oslSignalAction (SAL_CALL *oslSignalHandlerFunction)(void* pData, oslSignalInfo* pInfo);
 
@@ -90,8 +90,7 @@ SAL_DLLPUBLIC oslSignalAction SAL_CALL osl_raiseSignal(
 
     On default error reporting is enabled after process startup.
 
-    @param  bEnable [in]
-    Enables or disables error reporting.
+    @param[in]  bEnable Enables or disables error reporting.
 
     @retval sal_True if previous state of error reporting was enabled
     @retval sal_False if previous state of error reporting was disabled

include/osl/socket_decl.hxx

@@ -314,15 +314,13 @@ namespace osl
 
 
         /** Queries the socket for its type.
-            @return one of:
-            <ul>
-            <li> <code>osl_Socket_TypeStream</code>
-            <li> <code>osl_Socket_TypeDgram</code>
-            <li> <code>osl_Socket_TypeRaw</code>
-            <li> <code>osl_Socket_TypeRdm</code>
-            <li> <code>osl_Socket_TypeSeqPacket</code>
-            <li> <code>osl_invalid_SocketType</code>, if an error occurred
-            </ul>
+
+            @retval osl_Socket_TypeStream
+            @retval osl_Socket_TypeDgram
+            @retval osl_Socket_TypeRaw
+            @retval osl_Socket_TypeRdm
+            @retval osl_Socket_TypeSeqPacket
+            @retval osl_invalid_SocketType if an error occurred
         */
         inline oslSocketType    SAL_CALL getType() const;
 

include/osl/thread.hxx

@@ -34,7 +34,7 @@ namespace osl
 /** threadFunc is the function which is executed by the threads
     created by the osl::Thread class. The function's signature
     matches the one of oslWorkerFunction which is declared in
-    osl/thread.h .
+    osl/thread.h
 */
 extern "C" inline void SAL_CALL threadFunc( void* param);
 

include/osl/time.h

@@ -84,7 +84,7 @@ extern "C" {
 
 typedef struct _oslDateTime
 {
-    /** contains the nanoseconds .
+    /** contains the nanoseconds
     */
     sal_uInt32 NanoSeconds;