osl: doxygen fixes for headers

Change-Id: I3f30b5ab985c2ff709116568905b941c5d50fd1a

1 files changed, 69 insertions, 66 deletions

diff --git a/include/osl/process.h b/include/osl/process.h
index 49fe59264059..3c58419420d0 100644
--- a/include/osl/process.h
+++ b/include/osl/process.h
@@ -101,43 +101,43 @@ typedef void* oslProcess;
 
     Executes the program image provided in strImageName in a new process.
 
-    @param ustrImageName
-    [in] The file URL of the executable to be started.
+    @param[in] ustrImageName
+    The file URL of the executable to be started.
     Can be NULL in this case the file URL of the executable must be the first element
     in ustrArguments.
 
-    @param ustrArguments
-    [in] An array of argument strings. Can be NULL if strImageName is not NULL.
+    @param[in] ustrArguments
+    An array of argument strings. Can be NULL if strImageName is not NULL.
     If strImageName is NULL it is expected that the first element contains
     the file URL of the executable to start.
 
-    @param nArguments
-    [in] The number of arguments provided. If this number is 0 strArguments will be ignored.
+    @param[in] nArguments
+    The number of arguments provided. If this number is 0 strArguments will be ignored.
 
-    @param Options
-    [in] A combination of int-constants to describe the mode of execution.
+    @param[in] Options
+    A combination of int-constants to describe the mode of execution.
 
-    @param Security
-    [in] The user and his rights for which the process is started. May be NULL in which case
+    @param[in] Security
+    The user and his rights for which the process is started. May be NULL in which case
     the process will be started in the context of the current user.
 
-    @param ustrDirectory
-    [in] The file URL of the working directory of the new process. If the specified directory
+    @param[in] ustrDirectory
+    The file URL of the working directory of the new process. If the specified directory
     does not exist or is inaccessible the working directory of the newly created process
     is undefined. If this parameter is NULL or the caller provides an empty string the
     new process will have the same current working directory as the calling process.
 
-    @param ustrEnvironments
-    [in] An array of strings describing environment variables that should be merged into the
+    @param[in] ustrEnvironments
+    An array of strings describing environment variables that should be merged into the
     environment of the new process. Each string has to be in the form "variable=value".
     This parameter can be NULL in which case the new process gets the same environment
     as the parent process.
 
-    @param nEnvironmentVars
-    [in] The number of environment variables to set.
+    @param[in] nEnvironmentVars
+    The number of environment variables to set.
 
-    @param pProcess
-    [out] Pointer to a oslProcess variable, which receives the handle of the newly created process.
+    @param[out] pProcess
+    Pointer to a oslProcess variable, which receives the handle of the newly created process.
     This parameter must not be NULL.
 
     @retval osl_Process_E_None on success
@@ -164,57 +164,57 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess(
 
 /** Execute a process and redirect child process standard IO.
 
-    @param strImageName
-    [in] The file URL of the executable to be started.
+    @param[in] strImageName
+    The file URL of the executable to be started.
     Can be NULL in this case the file URL of the executable must be the first element
     in ustrArguments.
 
-    @param ustrArguments
-    [in] An array of argument strings. Can be NULL if strImageName is not NULL.
+    @param[in] ustrArguments
+    An array of argument strings. Can be NULL if strImageName is not NULL.
     If strImageName is NULL it is expected that the first element contains
     the file URL of the executable to start.
 
-    @param nArguments
-    [in] The number of arguments provided. If this number is 0 strArguments will be ignored.
+    @param[in] nArguments
+    The number of arguments provided. If this number is 0 strArguments will be ignored.
 
-    @param Options
-    [in] A combination of int-constants to describe the mode of execution.
+    @param[in] Options
+    A combination of int-constants to describe the mode of execution.
 
-    @param Security
-    [in] The user and his rights for which the process is started. May be NULL in which case
+    @param[in] Security
+    The user and his rights for which the process is started. May be NULL in which case
     the process will be started in the context of the current user.
 
-    @param ustrDirectory
-    [in] The file URL of the working directory of the new process. If the specified directory
+    @param[in] ustrDirectory
+    The file URL of the working directory of the new process. If the specified directory
     does not exist or is inaccessible the working directory of the newly created process
     is undefined. If this parameter is NULL or the caller provides an empty string the
     new process will have the same current working directory as the calling process.
 
-    @param ustrEnvironments
-    [in] An array of strings describing environment variables that should be merged into the
+    @param[in] ustrEnvironments
+    An array of strings describing environment variables that should be merged into the
     environment of the new process. Each string has to be in the form "variable=value".
     This parameter can be NULL in which case the new process gets the same environment
     as the parent process.
 
-    @param nEnvironmentVars
-    [in] The number of environment variables to set.
+    @param[in] nEnvironmentVars
+    The number of environment variables to set.
 
-    @param pProcess
-    [out] Pointer to a oslProcess variable, which receives the handle of the newly created process.
+    @param[out] pProcess
+    Pointer to a oslProcess variable, which receives the handle of the newly created process.
     This parameter must not be NULL.
 
-    @param pChildInputWrite
-    [in] Pointer to a oslFileHandle variable that receives the handle which can be used to write
+    @param[in] pChildInputWrite
+    Pointer to a oslFileHandle variable that receives the handle which can be used to write
     to the child process standard input device. The returned handle is not random accessible.
     The handle has to be closed with osl_closeFile if no longer used. This parameter can be NULL.
 
-    @param pChildOutputRead
-    [in] Pointer to a oslFileHandle variable that receives the handle which can be used to read from
+    @param[in] pChildOutputRead
+    Pointer to a oslFileHandle variable that receives the handle which can be used to read from
     the child process standard output device. The returned handle is not random accessible.
     The Handle has to be closed with osl_closeFile if no longer used. This parameter can be NULL.
 
-    @param pChildErrorRead
-    [in] Pointer to a oslFileHandle variable that receives the handle which can be used to read from
+    @param[in] pChildErrorRead
+    Pointer to a oslFileHandle variable that receives the handle which can be used to read from
     the child process standard error device. The returned handle is not random accessible.
     The Handle has to be closed with osl_closeFile if no longer used. This parameter can be NULL.
 
@@ -244,7 +244,8 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess_WithRedirectedIO(
     oslFileHandle* pChildErrorRead);
 
 /** Terminate a process
-    @param Process [in] the handle of the process to be terminated
+
+    @param[in] Process the handle of the process to be terminated
 
     @see osl_executeProcess
     @see osl_getProcess
@@ -255,8 +256,10 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_terminateProcess(
 
 
 /** @deprecated
+
     Retrieve the process handle of a process identifier
-    @param Ident [in] a process identifier
+
+    @param[in] Ident a process identifier
 
     @return the process handle on success, NULL in all other cases
  */
@@ -265,15 +268,18 @@ SAL_DLLPUBLIC oslProcess SAL_CALL osl_getProcess(
 
 
 /** Free the specified process-handle.
-    @param Process [in]
+
+    @param[in] Process
 */
 SAL_DLLPUBLIC void SAL_CALL osl_freeProcessHandle(
         oslProcess Process);
 
 
 /** Wait for completion of the specified childprocess.
-    @param Process [in]
+    @param[in] Process
+
     @retval ols_Process_E_None
+
     @see osl_executeProcess
 */
 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcess(
@@ -282,12 +288,9 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcess(
 /** Wait with a timeout for the completion of the specified child
     process.
 
-    @param Process [in]
-    A process identifier.
-
-    @param pTimeout [in]
-    A timeout value or NULL for infinite waiting.
-    The unit of resolution is second.
+    @param[in] Process A process identifier.
+    @param[in] pTimeout A timeout value or NULL for infinite waiting.
+        The unit of resolution is second.
 
     @retval osl_Process_E_None on success
     @retval osl_Process_E_TimedOut waiting for the child process timed out
@@ -318,7 +321,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessInfo(
         oslProcess Process, oslProcessData Fields, oslProcessInfo* pInfo);
 
 /** Get the filename of the executable.
-    @param strFile [out] the string that receives the executable file path.
+    @param[out] strFile the string that receives the executable file path.
     @return osl_Process_E_None or does not return.
     @see osl_executeProcess
 
@@ -338,8 +341,8 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getExecutableFile(
 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getCommandArgCount(void);
 
 /** Get the nArg-th command-line argument passed to the main-function of this process.
-    @param nArg [in] The number of the argument to return.
-    @param strCommandArg [out] The string receives the nArg-th command-line argument.
+    @param[in] nArg  The number of the argument to return.
+    @param[out] strCommandArg The string receives the nArg-th command-line argument.
     @return osl_Process_E_None or does not return.
     @see osl_executeProcess
 */
@@ -353,8 +356,8 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getCommandArg(
     be taken. This is due to Windows 9x/ME limitation that don't allow UTF-16 wmain to provide
     a osl_setCommandArgsU( int argc, sal_Unicode **argv );
 
-    @param argc [in] The number of elements in the argv array.
-    @param argv [in] The array of command-line arguments.
+    @param[in] argc  The number of elements in the argv array.
+    @param[in] argv  The array of command-line arguments.
     @see osl_getExecutableFile
     @see osl_getCommandArgCount
     @see osl_getCommandArg
@@ -362,15 +365,15 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getCommandArg(
 SAL_DLLPUBLIC void SAL_CALL osl_setCommandArgs (int argc, char **argv);
 
 /** Get the value of one environment variable.
-    @param strVar [in] denotes the name of the variable to get.
-    @param strValue [out] string that receives the value of environment variable.
+    @param[in] strVar  denotes the name of the variable to get.
+    @param[out] strValue string that receives the value of environment variable.
 */
 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getEnvironment(
         rtl_uString *strVar, rtl_uString **strValue);
 
 /** Set the value of one environment variable.
-    @param strVar [in] denotes the name of the variable to set.
-    @param strValue [in] string of the new value of environment variable.
+    @param[in] strVar  denotes the name of the variable to set.
+    @param[in] strValue  string of the new value of environment variable.
 
     @since UDK 3.2.13
 */
@@ -378,7 +381,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_setEnvironment(
         rtl_uString *strVar, rtl_uString *strValue);
 
 /** Unsets the value of one environment variable.
-    @param strVar [in] denotes the name of the variable to unset.
+    @param[in] strVar  denotes the name of the variable to unset.
 
     @since UDK 3.2.13
 */
@@ -388,7 +391,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_clearEnvironment(
 /** Get the working directory of the current process as a file URL.
 
     The file URL is encoded as common for the OSL file API.
-    @param  pustrWorkingDir [out] string that receives the working directory file URL.
+    @param[out] pustrWorkingDir string that receives the working directory file URL.
 */
 
 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessWorkingDir(
@@ -396,7 +399,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessWorkingDir(
 
 /** Get the locale the process is currently running in.
 
-    @param  ppLocale [out] a pointer that receives the currently selected locale structure
+    @param[out] ppLocale a pointer that receives the currently selected locale structure
 */
 
 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessLocale(
@@ -404,10 +407,10 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessLocale(
 
 /** Change the locale of the process.
 
-    @param  pLocale [in] a pointer to the locale to be set
+    @param[in] pLocale  a pointer to the locale to be set
 
     @deprecated  LibreOffice itself does not use this, and client code should
-    not have good use for it either.  It may eventually be removed.
+        not have good use for it either.  It may eventually be removed.
 */
 
 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_setProcessLocale(