Kaydet (Commit) 53358305 authored tarafından Norbert Thiebaud's avatar Norbert Thiebaud

kill some doxygen warnings

üst 6accc1e6
...@@ -318,7 +318,7 @@ void SAL_CALL typereg_reader_getFieldTypeName( ...@@ -318,7 +318,7 @@ void SAL_CALL typereg_reader_getFieldTypeName(
@param type an out-parameter obtaining the field value's type; must not be @param type an out-parameter obtaining the field value's type; must not be
null null
@param result an out-parameter obtaining the field value's value; must not be @param value an out-parameter obtaining the field value's value; must not be
null null
@return false iff an out-of-memory condition occurred, in which case @return false iff an out-of-memory condition occurred, in which case
......
...@@ -58,7 +58,7 @@ RegError REGISTRY_CALLTYPE reg_createKey(RegKeyHandle hKey, ...@@ -58,7 +58,7 @@ RegError REGISTRY_CALLTYPE reg_createKey(RegKeyHandle hKey,
@param hKey identifies a currently open key. The key which will be opened by this function @param hKey identifies a currently open key. The key which will be opened by this function
is a subkey of the key identified by hKey is a subkey of the key identified by hKey
@param keyName points to a null terminated string specifying the name of a key. @param keyName points to a null terminated string specifying the name of a key.
@param phNewKey points to a variable that receives the handle of the opened key. @param phOpenKey points to a variable that receives the handle of the opened key.
The memory to store this variable will be allocated and will be freed by the function The memory to store this variable will be allocated and will be freed by the function
reg_closeKey. If the function fails, phNewKey is NULL. reg_closeKey. If the function fails, phNewKey is NULL.
@return REG_NO_ERROR if succeeds else an error code. @return REG_NO_ERROR if succeeds else an error code.
...@@ -415,7 +415,7 @@ RegError REGISTRY_CALLTYPE reg_openRootKey(RegHandle hRegistry, ...@@ -415,7 +415,7 @@ RegError REGISTRY_CALLTYPE reg_openRootKey(RegHandle hRegistry,
/** This function returns the name of a registry. /** This function returns the name of a registry.
@param hReg identifies a currently open registry whose name will be returned. @param hRegistry identifies a currently open registry whose name will be returned.
@param pName returns the name of the registry if the function succeeds otherwise an empty string. @param pName returns the name of the registry if the function succeeds otherwise an empty string.
@return REG_NO_ERROR if succeeds else an error code. @return REG_NO_ERROR if succeeds else an error code.
*/ */
......
...@@ -146,7 +146,7 @@ typedef void* oslProcess; ...@@ -146,7 +146,7 @@ typedef void* oslProcess;
is undefined. If this parameter is NULL or the caller provides an empty string the 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. new process will have the same current working directory as the calling process.
@param ustrEnviroments @param ustrEnvironments
[in] An array of strings describing environment variables that should be merged into the [in] 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". 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 This parameter can be NULL in which case the new process gets the same environment
...@@ -190,7 +190,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess( ...@@ -190,7 +190,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess(
/** Execute a process and redirect child process standard IO. /** Execute a process and redirect child process standard IO.
@param ustrImageName @param strImageName
[in] The file URL of the executable to be started. [in] 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 Can be NULL in this case the file URL of the executable must be the first element
in ustrArguments. in ustrArguments.
...@@ -216,7 +216,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess( ...@@ -216,7 +216,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess(
is undefined. If this parameter is NULL or the caller provides an empty string the 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. new process will have the same current working directory as the calling process.
@param ustrEnviroments @param ustrEnvironments
[in] An array of strings describing environment variables that should be merged into the [in] 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". 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 This parameter can be NULL in which case the new process gets the same environment
...@@ -333,14 +333,14 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcessWithTimeout( ...@@ -333,14 +333,14 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcessWithTimeout(
oslProcess Process, const TimeValue* pTimeout); oslProcess Process, const TimeValue* pTimeout);
/** Retrieves information about a Process /** Retrieves information about a Process
@param Process [in] the process handle of the process @param[in] Process the process handle of the process
@param Field [in] the information which is to be retrieved @param[in] Fields the information which is to be retrieved
this can be one or more of this can be one or more of
osl_Process_IDENTIFIER osl_Process_IDENTIFIER
osl_Process_EXITCODE osl_Process_EXITCODE
osl_Process_CPUTIMES osl_Process_CPUTIMES
osl_Process_HEAPUSAGE osl_Process_HEAPUSAGE
@param pInfo [out] a pointer to a vaid oslProcessInfo structure. @param[out] pInfo a pointer to a vaid oslProcessInfo structure.
the Size field has to be initialized with the size the Size field has to be initialized with the size
of the oslProcessInfo structure. of the oslProcessInfo structure.
on success the the Field member holds the (or'ed) on success the the Field member holds the (or'ed)
......
...@@ -208,7 +208,7 @@ typedef sal_uInt8 oslSocketIpxNodeNumber[6]; ...@@ -208,7 +208,7 @@ typedef sal_uInt8 oslSocketIpxNodeNumber[6];
*/ */
/** Creates a socket-address for the given family. /** Creates a socket-address for the given family.
@param family If family == osl_Socket_FamilyInet the address is @param Family If family == osl_Socket_FamilyInet the address is
set to INADDR_ANY port 0. set to INADDR_ANY port 0.
@return 0 if address could not be created. @return 0 if address could not be created.
*/ */
......
...@@ -105,20 +105,20 @@ SAL_DLLPUBLIC void SAL_CALL rtl_locale_setDefault( ...@@ -105,20 +105,20 @@ SAL_DLLPUBLIC void SAL_CALL rtl_locale_setDefault(
/** /**
Getter for programmatic name of field, Getter for programmatic name of field,
a lowercased two-letter ISO 639-1 or three-letter ISO 639-3 code. a lowercased two-letter ISO 639-1 or three-letter ISO 639-3 code.
@see #getDisplayLanguage @see getDisplayLanguage
*/ */
SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getLanguage( rtl_Locale * This ); SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getLanguage( rtl_Locale * This );
/** /**
Getter for programmatic name of field, Getter for programmatic name of field,
an uppercased two-letter ISO-3166 code. an uppercased two-letter ISO-3166 code.
@see #getDisplayCountry @see getDisplayCountry
*/ */
SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getCountry( rtl_Locale * This ); SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getCountry( rtl_Locale * This );
/** /**
Getter for programmatic name of field. Getter for programmatic name of field.
@see #getDisplayVariant @see getDisplayVariant
*/ */
SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getVariant( rtl_Locale * This ); SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getVariant( rtl_Locale * This );
......
...@@ -45,7 +45,7 @@ extern "C" { ...@@ -45,7 +45,7 @@ extern "C" {
RTL_LOGFILE. If the variable is not empty, it creates a file with the name RTL_LOGFILE. If the variable is not empty, it creates a file with the name
$(RTL_LOGFILE)_$(PID).log, where $(PID) is the process id of the running process. $(RTL_LOGFILE)_$(PID).log, where $(PID) is the process id of the running process.
@param pszformat A format string with fprintf-syntax @param pszFormat A format string with fprintf-syntax
@param ... An arbitrary number of arguments for fprintf, matching the @param ... An arbitrary number of arguments for fprintf, matching the
format string. format string.
*/ */
......
...@@ -77,9 +77,9 @@ SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool ( ...@@ -77,9 +77,9 @@ SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
/** Add bytes to a Random Pool. /** Add bytes to a Random Pool.
@param Pool [in] a Random Pool. @param[in] Pool a Random Pool.
@param pBuffer [in] a buffer containing the bytes to add. @param[in] Buffer a buffer containing the bytes to add.
@param nBufLen [in] the number of bytes to read from the buffer. @param[in] Bytes the number of bytes to read from the buffer.
@return rtl_Random_E_None upon success. @return rtl_Random_E_None upon success.
*/ */
SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes ( SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
...@@ -90,9 +90,9 @@ SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes ( ...@@ -90,9 +90,9 @@ SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
/** Retrieve bytes from a Random Pool. /** Retrieve bytes from a Random Pool.
@param Pool [in] a Random Pool. @param[in] Pool a Random Pool.
@param pBuffer [inout] a buffer to receive the random bytes. @param[in,out] Buffer a buffer to receive the random bytes.
@param nBufLen [in] the number of bytes to write to the buffer. @param[in] Bytes the number of bytes to write to the buffer.
@return rtl_Random_E_None upon success. @return rtl_Random_E_None upon success.
*/ */
SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes ( SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
......
...@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_newFromStr_WithLength( ...@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_newFromStr_WithLength(
SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_stringbuffer_newFromStringBuffer( SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_stringbuffer_newFromStringBuffer(
rtl_String ** newStr, rtl_String ** newStr,
sal_Int32 capacity, sal_Int32 capacity,
rtl_String * olsStr ); rtl_String * oldStr );
/** /**
Ensures that the capacity of the buffer is at least equal to the Ensures that the capacity of the buffer is at least equal to the
...@@ -105,7 +105,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_ensureCapacity( ...@@ -105,7 +105,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_ensureCapacity(
@param capacity the capacity of the string buffer @param capacity the capacity of the string buffer
@param offset the offset. @param offset the offset.
@param ch a character array. @param str a character array.
@param len the number of characters to append. @param len the number of characters to append.
*/ */
SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_insert( SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_insert(
......
...@@ -959,7 +959,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newConcat( rtl_String ** newStr, rtl_Stri ...@@ -959,7 +959,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newConcat( rtl_String ** newStr, rtl_Stri
@param str @param str
a valid string. a valid string.
@param index @param idx
the index into str at which to start replacement. Must be between 0 and the index into str at which to start replacement. Must be between 0 and
the length of str, inclusive. the length of str, inclusive.
...@@ -1103,7 +1103,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newTrim( ...@@ -1103,7 +1103,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newTrim(
@param cTok @param cTok
the character that seperates the tokens. the character that seperates the tokens.
@param index @param idx
the position at which searching for the token starts. Must not be greater the position at which searching for the token starts. Must not be greater
than the length of str. than the length of str.
......
...@@ -196,7 +196,7 @@ SAL_DLLPUBLIC rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromMimeCharset( ...@@ -196,7 +196,7 @@ SAL_DLLPUBLIC rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromMimeCharset(
/** Map from a Unix charset to a text encoding. /** Map from a Unix charset to a text encoding.
@param pMimeCharset @param pUnixCharset
Any Unix charset string. Must not be null. Any Unix charset string. Must not be null.
@return @return
......
...@@ -221,7 +221,7 @@ once then every registration is treated as if made for a different listener. Tha ...@@ -221,7 +221,7 @@ once then every registration is treated as if made for a different listener. Tha
a different cookie is returned and the callback function will be called as many times a different cookie is returned and the callback function will be called as many times
as it has been registered. as it has been registered.
@param callback - a function that is called to notify listeners. @param callback - a function that is called to notify listeners.
@param this - a value to distinguish different listener instances @param _this - a value to distinguish different listener instances
@return identifier which is used in rtl_removeUnloadingListener @return identifier which is used in rtl_removeUnloadingListener
*/ */
SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_addUnloadingListener( rtl_unloadingListenerFunc callback, void* _this); SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_addUnloadingListener( rtl_unloadingListenerFunc callback, void* _this);
......
...@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uStringbuffer_newFromStr_WithLength( ...@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uStringbuffer_newFromStr_WithLength(
SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_uStringbuffer_newFromStringBuffer( SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_uStringbuffer_newFromStringBuffer(
rtl_uString ** newStr, rtl_uString ** newStr,
sal_Int32 capacity, sal_Int32 capacity,
rtl_uString * olsStr ); rtl_uString * oldStr );
/** /**
Ensures that the capacity of the buffer is at least equal to the Ensures that the capacity of the buffer is at least equal to the
......
...@@ -1165,7 +1165,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_new( ...@@ -1165,7 +1165,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_new(
pointer to the new string. The pointed-to data must be null or a valid pointer to the new string. The pointed-to data must be null or a valid
string. string.
@param len @param nLen
the number of characters. the number of characters.
*/ */
SAL_DLLPUBLIC void SAL_CALL rtl_uString_new_WithLength( SAL_DLLPUBLIC void SAL_CALL rtl_uString_new_WithLength(
...@@ -1343,7 +1343,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newConcat( ...@@ -1343,7 +1343,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newConcat(
@param str @param str
a valid string. a valid string.
@param index @param idx
the index into str at which to start replacement. Must be between 0 and the index into str at which to start replacement. Must be between 0 and
the length of str, inclusive. the length of str, inclusive.
...@@ -1487,7 +1487,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newTrim( ...@@ -1487,7 +1487,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newTrim(
@param cTok @param cTok
the character that seperates the tokens. the character that seperates the tokens.
@param index @param idx
the position at which searching for the token starts. Must not be greater the position at which searching for the token starts. Must not be greater
than the length of str. than the length of str.
......
...@@ -193,7 +193,7 @@ inline char const * unwrapStream(StreamIgnore const &) { ...@@ -193,7 +193,7 @@ inline char const * unwrapStream(StreamIgnore const &) {
would be an example of such a call; if the given s is of type rtl::OUString, would be an example of such a call; if the given s is of type rtl::OUString,
#include "rtl/oustringostreaminserter.hxx" \#include "rtl/oustringostreaminserter.hxx"
would make sure that an appropriate operator << is available. would make sure that an appropriate operator << is available.
......
...@@ -464,7 +464,7 @@ template< typename T1, typename T2 > inline T1 static_int_cast(T2 n) { ...@@ -464,7 +464,7 @@ template< typename T1, typename T2 > inline T1 static_int_cast(T2 n) {
/** /**
Use as follows: Use as follows:
SAL_WNODEPRECATED_DECLARATIONS_PUSH SAL_WNODEPRECATED_DECLARATIONS_PUSH
::std::auto_ptr<X> ... \::std::auto_ptr<X> ...
SAL_WNODEPRECATED_DECLARATIONS_POP SAL_WNODEPRECATED_DECLARATIONS_POP
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment