summaryrefslogtreecommitdiff
path: root/include/osl
diff options
context:
space:
mode:
authorChris Sherlock <chris.sherlock79@gmail.com>2017-06-25 09:15:14 +1000
committerChris Sherlock <chris.sherlock79@gmail.com>2017-06-25 09:16:55 +1000
commit74b98e04d604b6713f0a66a8337db6a3c79ad23e (patch)
treed251a4c37c8bbecd93a8d402be4b1a33571b3a76 /include/osl
parentd88776a05676af89b3d6d798e073acf778206bc1 (diff)
osl: doxygen parblock
Change-Id: Ica1b604484c855a94c9a21fab04d62c2f5952fe7
Diffstat (limited to 'include/osl')
-rw-r--r--include/osl/file.h20
1 files changed, 12 insertions, 8 deletions
diff --git a/include/osl/file.h b/include/osl/file.h
index 9287987a57f2..5708bc4cfc7d 100644
--- a/include/osl/file.h
+++ b/include/osl/file.h
@@ -1419,14 +1419,18 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileURLFromSystemPath(
A system dependent path, a file URL, a file or relative directory.
@param[in] pustrSearchPath
- A list of system paths, in which a given file has to be searched. The Notation of a path
- list is system dependent, e.g. on UNIX system "/usr/bin:/bin" and on Windows "C:\BIN;C:\BATCH".
- These paths are only for the search of a file or a relative path, otherwise it will be ignored.
- If pustrSearchPath is NULL or while using the search path the search failed, the function
- searches for a matching file in all system directories and in the directories listed in the PATH
- environment variable.<br/> The value of an environment variable should be used (e.g.
- LD_LIBRARY_PATH) if the caller is not aware of the Operating System and so doesn't know which
- path list delimiter to use.
+ @parblock
+ A list of system paths, in which a given file has to be searched. The Notation of a path
+ list is system dependent, e.g. on UNIX system "/usr/bin:/bin" and on Windows "C:\BIN;C:\BATCH".
+ These paths are only for the search of a file or a relative path, otherwise it will be ignored.
+ If pustrSearchPath is NULL or while using the search path the search failed, the function
+ searches for a matching file in all system directories and in the directories listed in the PATH
+ environment variable.
+
+ The value of an environment variable should be used (e.g.
+ LD_LIBRARY_PATH) if the caller is not aware of the Operating System and so doesn't know which
+ path list delimiter to use.
+ @endparblock
@param[out] ppustrFileURL
On success it receives the full qualified file URL.