[Libreoffice-commits] .: cppuhelper/inc sal/inc
Norbert Thiebaud
nthiebaud at kemper.freedesktop.org
Thu Jan 19 18:19:28 PST 2012
cppuhelper/inc/cppuhelper/weak.hxx | 6 +++---
sal/inc/osl/file.hxx | 13 +++++--------
sal/inc/osl/pipe_decl.hxx | 4 ++--
sal/inc/osl/profile.hxx | 9 ++++-----
sal/inc/osl/security_decl.hxx | 22 +++++++++-------------
sal/inc/osl/socket_decl.hxx | 8 ++++----
sal/inc/rtl/logfile.hxx | 2 +-
sal/inc/rtl/string.hxx | 2 +-
sal/inc/rtl/ustrbuf.hxx | 6 +++---
9 files changed, 32 insertions(+), 40 deletions(-)
New commits:
commit 6ac30d8be976d60f56783327984b263fb1307e2a
Author: Norbert Thiebaud <nthiebaud at gmail.com>
Date: Thu Jan 19 20:18:48 2012 -0600
clean-up Doxygen warnings
diff --git a/cppuhelper/inc/cppuhelper/weak.hxx b/cppuhelper/inc/cppuhelper/weak.hxx
index b8b9ddd..ceddbda 100644
--- a/cppuhelper/inc/cppuhelper/weak.hxx
+++ b/cppuhelper/inc/cppuhelper/weak.hxx
@@ -130,8 +130,8 @@ public:
SAL_THROW( () )
{ return *this; }
- /** Basic queryInterface() implementation supporting ::com::sun::star::uno::XWeak and
- ::com::sun::star::uno::XInterface.
+ /** Basic queryInterface() implementation supporting \::com::sun::star::uno::XWeak and
+ \::com::sun::star::uno::XInterface.
@param rType demanded type
@return demanded type or empty any
@@ -150,7 +150,7 @@ public:
/** XWeak::queryAdapter() implementation
- @return a ::com::sun::star::uno::XAdapter reference
+ @return a \::com::sun::star::uno::XAdapter reference
*/
virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XAdapter > SAL_CALL queryAdapter()
throw (::com::sun::star::uno::RuntimeException);
diff --git a/sal/inc/osl/file.hxx b/sal/inc/osl/file.hxx
index 85393f5..d63126b 100644
--- a/sal/inc/osl/file.hxx
+++ b/sal/inc/osl/file.hxx
@@ -120,7 +120,7 @@ public:
@param ustrRequestedURL [in]
Requested name of a file or directory.
- @param pustrValidURL [out]
+ @param ustrValidURL [out]
On success receives a name which is unused and valid on the actual Operating System and
File System.
@@ -251,7 +251,7 @@ public:
/** Retrieves the file URL of the system's temporary directory path.
- @param ustrTempDirURL[out]
+ @param[out] ustrTempDirURL
On success receives the URL of system's temporary directory path.
@return
@@ -1529,16 +1529,13 @@ public:
return (RC) osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask );
}
-/** Determine if two directory items point the the same underlying file
+/** Determine if a directory item point the the same underlying file
The comparison is done first by URL, and then by resolving links to
find the target, and finally by comparing inodes on unix.
- @param pItemA [in]
- A directory handle to compare with another handle
-
- @param pItemB [in]
- A directory handle to compare with pItemA
+ @param[in] pOther
+ A directory handle to compare with the underlying object's item
@return
sal_True: if the items point to an identical resource<br>
diff --git a/sal/inc/osl/pipe_decl.hxx b/sal/inc/osl/pipe_decl.hxx
index 54ccb93..b361440 100644
--- a/sal/inc/osl/pipe_decl.hxx
+++ b/sal/inc/osl/pipe_decl.hxx
@@ -59,7 +59,7 @@ public:
/** Creates a secure pipe that access depends on the umask settings.
@param strName
@param Options
- @param Security
+ @param rSecurity
*/
inline Pipe(const ::rtl::OUString& strName, oslPipeOptions Options,const Security & rSecurity);
@@ -87,7 +87,7 @@ public:
If the pipe was already created, the old one will be discarded.
@param strName
@param Options
- @param Security
+ @param rSec
@return True if socket was successfully created.
*/
inline sal_Bool create( const ::rtl::OUString & strName,
diff --git a/sal/inc/osl/profile.hxx b/sal/inc/osl/profile.hxx
index 88476e0..e372285 100644
--- a/sal/inc/osl/profile.hxx
+++ b/sal/inc/osl/profile.hxx
@@ -62,7 +62,6 @@ namespace osl {
/** Close the opened profile an flush all data to the disk.
- @param Profile handle to a opened profile.
*/
~Profile()
{
@@ -143,8 +142,9 @@ namespace osl {
return bRet;
}
- /** Acquire the mutex, block if already acquired by another thread.
- @param Profile handle to a opened profile.
+ /** Remove an entry from a section.
+ @param rSection Name of the section.
+ @param rEntry Name of the entry to remove.
@return False if section or entry could not be found.
*/
sal_Bool removeEntry(const rtl::OString& rSection, const rtl::OString& rEntry)
@@ -153,7 +153,7 @@ namespace osl {
}
/** Get all entries belonging to the specified section.
- @param Profile handle to a opened profile.
+ @param rSection Name of the section.
@return Pointer to a array of pointers.
*/
std::list< rtl::OString > getSectionEntries(const rtl::OString& rSection )
@@ -176,7 +176,6 @@ namespace osl {
}
/** Get all section entries
- @param Profile handle to a opened profile.
@return Pointer to a array of pointers.
*/
std::list< rtl::OString > getSections()
diff --git a/sal/inc/osl/security_decl.hxx b/sal/inc/osl/security_decl.hxx
index 64664c6..d0a0cbc 100644
--- a/sal/inc/osl/security_decl.hxx
+++ b/sal/inc/osl/security_decl.hxx
@@ -52,8 +52,8 @@ public:
inline ~Security();
/** get the security information for one user.
The underlying operating system is asked for this information.
- @param strName [in] denotes the name of the user
- @param strPasswd [in] denotes the password of this user
+ @param[in] strName denotes the name of the user
+ @param[in] strPasswd denotes the password of this user
@return True, if the specified user is known by the underlying operating system,
otherwise False
*/
@@ -64,8 +64,8 @@ public:
If a network resource named \\server\username exists and this resource
could be connected by this user, the methos will return true and getHomeDir
will return \\server\username.
- @param strName [in] denotes the name of the user
- @param strPasswd [in] denotes the password of this user
+ @param[in] strName denotes the name of the user
+ @param[in] strPasswd denotes the password of this user
@return True, if the specified user is known by file server and the
could be connected, otherwise False
*/
@@ -74,29 +74,25 @@ public:
const rtl::OUString & strFileServer);
/** get the ident of the logged in user.
- @param strName [out] is the buffer which returns the name
- @param max [in] is the size of this buffer
+ @param[out] strName is the OUString which returns the name
@return True, if any user is successfuly logged in, otherwise False
*/
inline sal_Bool SAL_CALL getUserIdent( rtl::OUString& strIdent) const;
/** get the name of the logged in user.
- @param strName [out] is the buffer which returns the name
- @param max [in] is the size of this buffer
+ @param[out] strName is the OUString which returns the name
@return True, if any user is successfuly logged in, otherwise False
*/
inline sal_Bool SAL_CALL getUserName( rtl::OUString& strName) const;
/** get the home directory of the logged in user.
- @param strDirectory [out] is the buffer which returns the directory name
- @param max [in] is the size of this buffer
- @return True, if any user is successfuly logged in, otherwise False
+ @param[out] strDirectory is the OUString which returns the directory name
+ @return True, if any user is successfuly logged in, otherwise False
*/
inline sal_Bool SAL_CALL getHomeDir( rtl::OUString& strDirectory) const;
/** get the directory for configuration data of the logged in user.
- @param strDirectory [out] is the buffer which returns the directory name
- @param max [in] is the size of this buffer
+ @param[out] strDirectory is the OUString which returns the directory name
@return True, if any user is successfuly logged in, otherwise False
*/
inline sal_Bool SAL_CALL getConfigDir( rtl::OUString & strDirectory) const;
diff --git a/sal/inc/osl/socket_decl.hxx b/sal/inc/osl/socket_decl.hxx
index 38d0242..0c26f25 100644
--- a/sal/inc/osl/socket_decl.hxx
+++ b/sal/inc/osl/socket_decl.hxx
@@ -392,7 +392,7 @@ namespace osl
level <code>osl_Socket_LevelSocket</code>.
@param pBuffer The Buffer will be filled with the attribute.
- @param BufferSize The size of pBuffer.
+ @param BufferLen The size of pBuffer.
@param Level The option level.
@@ -545,10 +545,10 @@ namespace osl
/** Tries to receive BytesToRead data from the connected socket,
- @param pBuffer [out] Points to a buffer that will be filled with the received
+ @param[out] pBuffer Points to a buffer that will be filled with the received
data. pBuffer must have at least have a size of BytesToRead.
- @param BytesToRead [in] The number of bytes to read.
- @param Flag [in] Modifier for the call. Valid values are:
+ @param[in] BytesToRead The number of bytes to read.
+ @param[in] flags Modifier for the call. Valid values are:
<ul>
<li><code>osl_Socket_MsgNormal</code>
diff --git a/sal/inc/rtl/logfile.hxx b/sal/inc/rtl/logfile.hxx
index c67e67c..1ed8c66 100644
--- a/sal/inc/rtl/logfile.hxx
+++ b/sal/inc/rtl/logfile.hxx
@@ -42,7 +42,7 @@ namespace rtl
Therefore we have provided a set of macros that uses the class Logfile only if
this symbol is defined. If the macros are not sufficient, i.e. you need more
then three arguments for a printf style message, then you have to insert an
- #ifdef TIMELOG/#endif brace yourself.
+ \#ifdef TIMELOG/\#endif brace yourself.
Additionally the environment variable RTL_LOGFILE has to be defined in order to generate
logging information. If the variable is not empty, it creates a file with the name
diff --git a/sal/inc/rtl/string.hxx b/sal/inc/rtl/string.hxx
index ccd96b9..2bb7af3 100644
--- a/sal/inc/rtl/string.hxx
+++ b/sal/inc/rtl/string.hxx
@@ -122,7 +122,7 @@ public:
/** New string from OString data without acquiring it. Takeover of ownership.
@param str a OString data.
- @param dummy SAL_NO_ACQUIRE to distinguish from other ctors
+ @param __sal_NoAcquire SAL_NO_ACQUIRE to distinguish from other ctors
*/
inline OString( rtl_String * str, __sal_NoAcquire ) SAL_THROW(())
{
diff --git a/sal/inc/rtl/ustrbuf.hxx b/sal/inc/rtl/ustrbuf.hxx
index de49942..af008bf 100644
--- a/sal/inc/rtl/ustrbuf.hxx
+++ b/sal/inc/rtl/ustrbuf.hxx
@@ -126,7 +126,7 @@ public:
capacity of the string buffer is <code>16</code> plus the length
of the string argument.
- @param str the initial contents of the buffer.
+ @param value the initial contents of the buffer.
*/
OUStringBuffer(OUString value)
: pData(NULL)
@@ -430,7 +430,7 @@ public:
The argument is appended to the contents of this string buffer.
The length of this string buffer increases by <code>1</code>.
- @param ch an ASCII <code>char</code>.
+ @param c an ASCII <code>char</code>.
@return this string buffer.
@since LibreOffice 3.5
@@ -448,7 +448,7 @@ public:
The argument is appended to the contents of this string buffer.
The length of this string buffer increases by <code>1</code>.
- @param ch a <code>char</code>.
+ @param c a <code>char</code>.
@return this string buffer.
*/
OUStringBuffer & append(sal_Unicode c)
More information about the Libreoffice-commits
mailing list