diff options
| author | Chris Sherlock <chris.sherlock79@gmail.com> | 2017-07-19 12:59:27 +1000 |
|---|---|---|
| committer | Chris Sherlock <chris.sherlock79@gmail.com> | 2017-07-19 12:59:27 +1000 |
| commit | e57aad8e43bc2617e88caac515b3fe5a09349813 (patch) | |
| tree | bbf6b6b16f0e5a355a550479cadfeba320e06925 | |
| parent | c0d7f348f20ea1ae0d4b738136be4d5cbff550ae (diff) | |
osl: fix header comment
Change-Id: I06829e4ad0efc78244083e48bf9cd10422ff5e2e
| -rw-r--r-- | sal/osl/unx/file_error_transl.hxx | 29 |
1 files changed, 11 insertions, 18 deletions
diff --git a/sal/osl/unx/file_error_transl.hxx b/sal/osl/unx/file_error_transl.hxx index 51be5aacf998..5357db3d28b0 100644 --- a/sal/osl/unx/file_error_transl.hxx +++ b/sal/osl/unx/file_error_transl.hxx @@ -23,29 +23,22 @@ #include <osl/file.h> #include <sal/types.h> -/********************************************* - oslTranslateFileError - Translate errno's to osl file errors - - @param bIsError [in] specifies if nErrno - should be interpreted as error, - some libc functions signaling an error - but errno is nevertheless 0 in this - case the function should at least - return osl_File_E_Unknown but in no - case osl_File_E_None! +#define OSL_FET_ERROR true - @param nErrno [in] the errno if errno is 0 - and bIsError is true the function - returns osl_File_E_Unknown +/** Translate errno's to osl file errors - @returns the osl error code appropriate to - the errno + @param [in] bIsError specifies if nErrno should be interpreted as error, + some libc functions signaling an error but errno is + nevertheless 0 in this case the function should at + least return osl_File_E_Unknown but in no case + osl_File_E_None! - *********************************************/ + @param [in] nErrno the errno if errno is 0 and bIsError is true the + function returns osl_File_E_Unknown -#define OSL_FET_ERROR true + @returns the osl error code appropriate to the errno +*/ oslFileError oslTranslateFileError(bool bIsError, int Errno); #endif |