[Libreoffice-commits] .: registry/inc sal/inc
Norbert Thiebaud
nthiebaud at kemper.freedesktop.org
Fri Jan 20 15:17:44 PST 2012
registry/inc/registry/reader.h | 2 +-
registry/inc/registry/registry.h | 4 ++--
sal/inc/osl/process.h | 12 ++++++------
sal/inc/osl/socket.h | 2 +-
sal/inc/rtl/locale.h | 6 +++---
sal/inc/rtl/logfile.h | 2 +-
sal/inc/rtl/random.h | 12 ++++++------
sal/inc/rtl/strbuf.h | 4 ++--
sal/inc/rtl/string.h | 4 ++--
sal/inc/rtl/tencinfo.h | 2 +-
sal/inc/rtl/unload.h | 2 +-
sal/inc/rtl/ustrbuf.h | 2 +-
sal/inc/rtl/ustring.h | 6 +++---
sal/inc/sal/log.hxx | 2 +-
sal/inc/sal/types.h | 2 +-
15 files changed, 32 insertions(+), 32 deletions(-)
New commits:
commit 53358305d8620f703d14df3c37a9b65e29a20cb4
Author: Norbert Thiebaud <nthiebaud at gmail.com>
Date: Fri Jan 20 17:16:19 2012 -0600
kill some doxygen warnings
diff --git a/registry/inc/registry/reader.h b/registry/inc/registry/reader.h
index e455d0a..cdbd0ba 100644
--- a/registry/inc/registry/reader.h
+++ b/registry/inc/registry/reader.h
@@ -318,7 +318,7 @@ void SAL_CALL typereg_reader_getFieldTypeName(
@param type an out-parameter obtaining the field value's type; must not be
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
@return false iff an out-of-memory condition occurred, in which case
diff --git a/registry/inc/registry/registry.h b/registry/inc/registry/registry.h
index a35c9df..5374d65 100644
--- a/registry/inc/registry/registry.h
+++ b/registry/inc/registry/registry.h
@@ -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
is a subkey of the key identified by hKey
@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
reg_closeKey. If the function fails, phNewKey is NULL.
@return REG_NO_ERROR if succeeds else an error code.
@@ -415,7 +415,7 @@ RegError REGISTRY_CALLTYPE reg_openRootKey(RegHandle hRegistry,
/** 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.
@return REG_NO_ERROR if succeeds else an error code.
*/
diff --git a/sal/inc/osl/process.h b/sal/inc/osl/process.h
index 2eb2954..bd8c2c4 100644
--- a/sal/inc/osl/process.h
+++ b/sal/inc/osl/process.h
@@ -146,7 +146,7 @@ typedef void* oslProcess;
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 ustrEnviroments
+ @param ustrEnvironments
[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".
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(
/** Execute a process and redirect child process standard IO.
- @param ustrImageName
+ @param strImageName
[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
in ustrArguments.
@@ -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
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
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
@@ -333,14 +333,14 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcessWithTimeout(
oslProcess Process, const TimeValue* pTimeout);
/** Retrieves information about a Process
- @param Process [in] the process handle of the process
- @param Field [in] the information which is to be retrieved
+ @param[in] Process the process handle of the process
+ @param[in] Fields the information which is to be retrieved
this can be one or more of
osl_Process_IDENTIFIER
osl_Process_EXITCODE
osl_Process_CPUTIMES
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
of the oslProcessInfo structure.
on success the the Field member holds the (or'ed)
diff --git a/sal/inc/osl/socket.h b/sal/inc/osl/socket.h
index 19554e6..74b55a6 100644
--- a/sal/inc/osl/socket.h
+++ b/sal/inc/osl/socket.h
@@ -208,7 +208,7 @@ typedef sal_uInt8 oslSocketIpxNodeNumber[6];
*/
/** 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.
@return 0 if address could not be created.
*/
diff --git a/sal/inc/rtl/locale.h b/sal/inc/rtl/locale.h
index e29ed0e..3e67faf 100644
--- a/sal/inc/rtl/locale.h
+++ b/sal/inc/rtl/locale.h
@@ -105,20 +105,20 @@ SAL_DLLPUBLIC void SAL_CALL rtl_locale_setDefault(
/**
Getter for programmatic name of field,
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 );
/**
Getter for programmatic name of field,
an uppercased two-letter ISO-3166 code.
- @see #getDisplayCountry
+ @see getDisplayCountry
*/
SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getCountry( rtl_Locale * This );
/**
Getter for programmatic name of field.
- @see #getDisplayVariant
+ @see getDisplayVariant
*/
SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getVariant( rtl_Locale * This );
diff --git a/sal/inc/rtl/logfile.h b/sal/inc/rtl/logfile.h
index ce89345..54027ac 100644
--- a/sal/inc/rtl/logfile.h
+++ b/sal/inc/rtl/logfile.h
@@ -45,7 +45,7 @@ extern "C" {
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.
- @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
format string.
*/
diff --git a/sal/inc/rtl/random.h b/sal/inc/rtl/random.h
index 45d8c0d..1a54a4a 100644
--- a/sal/inc/rtl/random.h
+++ b/sal/inc/rtl/random.h
@@ -77,9 +77,9 @@ SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
/** Add bytes to a Random Pool.
- @param Pool [in] a Random Pool.
- @param pBuffer [in] a buffer containing the bytes to add.
- @param nBufLen [in] the number of bytes to read from the buffer.
+ @param[in] Pool a Random Pool.
+ @param[in] Buffer a buffer containing the bytes to add.
+ @param[in] Bytes the number of bytes to read from the buffer.
@return rtl_Random_E_None upon success.
*/
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.
- @param Pool [in] a Random Pool.
- @param pBuffer [inout] a buffer to receive the random bytes.
- @param nBufLen [in] the number of bytes to write to the buffer.
+ @param[in] Pool a Random Pool.
+ @param[in,out] Buffer a buffer to receive the random bytes.
+ @param[in] Bytes the number of bytes to write to the buffer.
@return rtl_Random_E_None upon success.
*/
SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
diff --git a/sal/inc/rtl/strbuf.h b/sal/inc/rtl/strbuf.h
index 5020515..64300ec 100644
--- a/sal/inc/rtl/strbuf.h
+++ b/sal/inc/rtl/strbuf.h
@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_newFromStr_WithLength(
SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_stringbuffer_newFromStringBuffer(
rtl_String ** newStr,
sal_Int32 capacity,
- rtl_String * olsStr );
+ rtl_String * oldStr );
/**
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(
@param capacity the capacity of the string buffer
@param offset the offset.
- @param ch a character array.
+ @param str a character array.
@param len the number of characters to append.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_insert(
diff --git a/sal/inc/rtl/string.h b/sal/inc/rtl/string.h
index 9b5f294..671d2fd 100644
--- a/sal/inc/rtl/string.h
+++ b/sal/inc/rtl/string.h
@@ -959,7 +959,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newConcat( rtl_String ** newStr, rtl_Stri
@param str
a valid string.
- @param index
+ @param idx
the index into str at which to start replacement. Must be between 0 and
the length of str, inclusive.
@@ -1103,7 +1103,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newTrim(
@param cTok
the character that seperates the tokens.
- @param index
+ @param idx
the position at which searching for the token starts. Must not be greater
than the length of str.
diff --git a/sal/inc/rtl/tencinfo.h b/sal/inc/rtl/tencinfo.h
index 304147f..086b5ab 100644
--- a/sal/inc/rtl/tencinfo.h
+++ b/sal/inc/rtl/tencinfo.h
@@ -196,7 +196,7 @@ SAL_DLLPUBLIC rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromMimeCharset(
/** Map from a Unix charset to a text encoding.
- @param pMimeCharset
+ @param pUnixCharset
Any Unix charset string. Must not be null.
@return
diff --git a/sal/inc/rtl/unload.h b/sal/inc/rtl/unload.h
index 9479f82..6a196b8 100644
--- a/sal/inc/rtl/unload.h
+++ b/sal/inc/rtl/unload.h
@@ -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
as it has been registered.
@param callback - a function that is called to notify listeners.
- at param this - a value to distinguish different listener instances
+ at param _this - a value to distinguish different listener instances
@return identifier which is used in rtl_removeUnloadingListener
*/
SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_addUnloadingListener( rtl_unloadingListenerFunc callback, void* _this);
diff --git a/sal/inc/rtl/ustrbuf.h b/sal/inc/rtl/ustrbuf.h
index a37cb6e..0863da0 100644
--- a/sal/inc/rtl/ustrbuf.h
+++ b/sal/inc/rtl/ustrbuf.h
@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uStringbuffer_newFromStr_WithLength(
SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_uStringbuffer_newFromStringBuffer(
rtl_uString ** newStr,
sal_Int32 capacity,
- rtl_uString * olsStr );
+ rtl_uString * oldStr );
/**
Ensures that the capacity of the buffer is at least equal to the
diff --git a/sal/inc/rtl/ustring.h b/sal/inc/rtl/ustring.h
index 699d3a0..e75185b 100644
--- a/sal/inc/rtl/ustring.h
+++ b/sal/inc/rtl/ustring.h
@@ -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
string.
- @param len
+ @param nLen
the number of characters.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_uString_new_WithLength(
@@ -1343,7 +1343,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newConcat(
@param str
a valid string.
- @param index
+ @param idx
the index into str at which to start replacement. Must be between 0 and
the length of str, inclusive.
@@ -1487,7 +1487,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newTrim(
@param cTok
the character that seperates the tokens.
- @param index
+ @param idx
the position at which searching for the token starts. Must not be greater
than the length of str.
diff --git a/sal/inc/sal/log.hxx b/sal/inc/sal/log.hxx
index 816d57a..52a0647 100644
--- a/sal/inc/sal/log.hxx
+++ b/sal/inc/sal/log.hxx
@@ -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,
- #include "rtl/oustringostreaminserter.hxx"
+ \#include "rtl/oustringostreaminserter.hxx"
would make sure that an appropriate operator << is available.
diff --git a/sal/inc/sal/types.h b/sal/inc/sal/types.h
index fa3a9d7..a331fe1 100644
--- a/sal/inc/sal/types.h
+++ b/sal/inc/sal/types.h
@@ -464,7 +464,7 @@ template< typename T1, typename T2 > inline T1 static_int_cast(T2 n) {
/**
Use as follows:
SAL_WNODEPRECATED_DECLARATIONS_PUSH
- ::std::auto_ptr<X> ...
+ \::std::auto_ptr<X> ...
SAL_WNODEPRECATED_DECLARATIONS_POP
*/
More information about the Libreoffice-commits
mailing list