summaryrefslogtreecommitdiff
path: root/sal
diff options
context:
space:
mode:
authorStephan Bergmann <sbergman@redhat.com>2012-01-05 19:40:38 +0100
committerStephan Bergmann <sbergman@redhat.com>2012-01-05 19:43:14 +0100
commit58ab12acf576a765ec47cc2753ba57643e51d653 (patch)
tree79c07bddbdf3e8e6db677eb0b94e8a2880d308c1 /sal
parent7482e974117df2bdc737785efdf9eb410787c7b4 (diff)
Switch from autodoc to doxygen for SDK C++ documentation.
* New build prerequisite doxygen (controllable via --with-doxygen). * Adapted various headers to slightly different doxygen documentation syntax, but much clean up still remains to be done (i.e., warnings emitted by doxygen fixed).
Diffstat (limited to 'sal')
-rw-r--r--sal/inc/osl/diagnose.h4
-rw-r--r--sal/inc/osl/diagnose.hxx15
-rw-r--r--sal/inc/osl/file.h33
-rw-r--r--sal/inc/osl/file.hxx2
-rw-r--r--sal/inc/osl/interlck.h4
-rw-r--r--sal/inc/osl/module.h6
-rw-r--r--sal/inc/osl/module.hxx2
-rw-r--r--sal/inc/osl/profile.h3
-rw-r--r--sal/inc/osl/security.h38
-rw-r--r--sal/inc/osl/security_decl.hxx18
-rw-r--r--sal/inc/osl/socket.h4
-rw-r--r--sal/inc/osl/socket_decl.hxx2
-rw-r--r--sal/inc/rtl/allocator.hxx11
-rw-r--r--sal/inc/rtl/bootstrap.h1
-rw-r--r--sal/inc/rtl/bootstrap.hxx6
-rw-r--r--sal/inc/rtl/byteseq.h7
-rw-r--r--sal/inc/rtl/instance.hxx20
-rw-r--r--sal/inc/rtl/math.h12
-rw-r--r--sal/inc/rtl/math.hxx2
-rw-r--r--sal/inc/rtl/ref.hxx5
-rw-r--r--sal/inc/rtl/strbuf.h3
-rw-r--r--sal/inc/rtl/strbuf.hxx4
-rw-r--r--sal/inc/rtl/string.h4
-rw-r--r--sal/inc/rtl/string.hxx5
-rw-r--r--sal/inc/rtl/unload.h1
-rw-r--r--sal/inc/rtl/uri.h16
-rw-r--r--sal/inc/rtl/uri.hxx12
-rw-r--r--sal/inc/rtl/ustrbuf.h3
-rw-r--r--sal/inc/rtl/ustrbuf.hxx21
-rw-r--r--sal/inc/rtl/ustring.h4
-rw-r--r--sal/inc/rtl/ustring.hxx17
-rw-r--r--sal/inc/rtl/uuid.h1
-rw-r--r--sal/inc/sal/detail/log.h4
-rw-r--r--sal/inc/sal/log.hxx7
34 files changed, 132 insertions, 165 deletions
diff --git a/sal/inc/osl/diagnose.h b/sal/inc/osl/diagnose.h
index dad4669b5dce..9a6112be0788 100644
--- a/sal/inc/osl/diagnose.h
+++ b/sal/inc/osl/diagnose.h
@@ -121,13 +121,13 @@ typedef void (SAL_CALL *pfunc_osl_printDetailedDebugMessage)( const sal_Char * p
The function set here is ignored if a function for detailed message information
(pfunc_osl_printDetailedDebugMessage) has been set.
- The given message handler must be able to cope with a <NULL/> message.
+ The given message handler must be able to cope with a null message.
*/
SAL_DLLPUBLIC pfunc_osl_printDebugMessage SAL_CALL osl_setDebugMessageFunc( pfunc_osl_printDebugMessage pNewFunc );
/** sets a delivery function for detailed message information.
- The given message handler must be able to cope with a <NULL/> message.
+ The given message handler must be able to cope with a null message.
*/
SAL_DLLPUBLIC pfunc_osl_printDetailedDebugMessage SAL_CALL osl_setDetailedDebugMessageFunc( pfunc_osl_printDetailedDebugMessage pNewFunc );
diff --git a/sal/inc/osl/diagnose.hxx b/sal/inc/osl/diagnose.hxx
index 7a8f5c189875..840f7a382c7d 100644
--- a/sal/inc/osl/diagnose.hxx
+++ b/sal/inc/osl/diagnose.hxx
@@ -42,8 +42,9 @@
#include "sal/log.hxx"
#include "sal/types.h"
+/// @cond INTERNAL
+
namespace osl {
-/// @internal
namespace detail {
struct ObjectRegistryData;
@@ -53,27 +54,22 @@ struct ObjectRegistryData;
extern "C" {
-/** @internal */
SAL_DLLPUBLIC bool SAL_CALL osl_detail_ObjectRegistry_storeAddresses(
char const* pName )
SAL_THROW_EXTERN_C();
-/** @internal */
SAL_DLLPUBLIC bool SAL_CALL osl_detail_ObjectRegistry_checkObjectCount(
::osl::detail::ObjectRegistryData const& rData, ::std::size_t nExpected )
SAL_THROW_EXTERN_C();
-/** @internal */
SAL_DLLPUBLIC void SAL_CALL osl_detail_ObjectRegistry_registerObject(
::osl::detail::ObjectRegistryData & rData, void const* pObj )
SAL_THROW_EXTERN_C();
-/** @internal */
SAL_DLLPUBLIC void SAL_CALL osl_detail_ObjectRegistry_revokeObject(
::osl::detail::ObjectRegistryData & rData, void const* pObj )
SAL_THROW_EXTERN_C();
-/** @internal */
SAL_DLLPUBLIC ::osl::Mutex & SAL_CALL osl_detail_ObjectRegistry_getMutex()
SAL_THROW_EXTERN_C();
@@ -81,7 +77,6 @@ SAL_DLLPUBLIC ::osl::Mutex & SAL_CALL osl_detail_ObjectRegistry_getMutex()
namespace osl {
-/// @internal
namespace detail {
struct VoidPtrHash : ::std::unary_function<void const*, ::std::size_t> {
@@ -162,8 +157,8 @@ private:
objects instead of just counting them. This enables you to iterate over
leaking objects in your debugger.
- @tpl InheritingClassT binds the template instance to that class
- @internal Use at own risk.
+ @tparam InheritingClassT binds the template instance to that class
+ @attention Use at own risk.
For now this is just public (yet unpublished) API and may change
in the future!
*/
@@ -198,6 +193,8 @@ private:
} // namespace osl
+/// @endcond
+
#endif // ! defined(OSL_DIAGNOSE_HXX_INCLUDED)
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sal/inc/osl/file.h b/sal/inc/osl/file.h
index ecf9e60a4d68..2a8cf378330b 100644
--- a/sal/inc/osl/file.h
+++ b/sal/inc/osl/file.h
@@ -26,8 +26,6 @@
*
************************************************************************/
-/** @HTML */
-
#ifndef _OSL_FILE_H_
#define _OSL_FILE_H_
@@ -1216,7 +1214,7 @@ typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData, rtl_uStri
[in] The absolute file URL of the directory path to create.
A relative file URL will not be accepted.
- @param aDirectoryCreationFunc
+ @param aDirectoryCreationCallbackFunc
[in] Pointer to a function that will be called synchronously
for each sub directory that was created. The value of this
parameter may be NULL, in this case notifications will not be
@@ -1517,12 +1515,12 @@ typedef sal_uInt32 (SAL_CALL *oslCalcTextWidthFunc)( rtl_uString *ustrText );
@param pustrCompacted [out]
Receives the compacted system path on output
- @param pfnCalcWidth [in]
+ @param pCalcWidth [in]
Function ptr that calculates the width of a string. Can be zero.
@param uMaxWidth [in]
- Maximum width allowed that is retunrned from pfnCalcWidth.
- If pfnCalcWidth is zero the character count is assumed as width.
+ Maximum width allowed that is retunrned from pCalcWidth.
+ If pCalcWidth is zero the character count is assumed as width.
@return
osl_File_E_None on success<br>
@@ -1587,7 +1585,7 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileTime(
/** Retrieves the file URL of the system's temporary directory path
- @param pustrTempDirURL[out]
+ @param[out] pustrTempDirURL
On success receives the URL of system's temporary directory path.
@return
@@ -1610,6 +1608,16 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
it, the file will be automatically removed on close else the caller is
responsible for removing the file on success.
+ Description of the different pHandle, ppustrTempFileURL parameter combinations.
+ pHandle is 0 and ppustrTempDirURL is 0 - this combination is invalid
+ pHandle is not 0 and ppustrTempDirURL is 0 - a handle to the open file
+ will be returned on success and the file will be automatically removed on close.
+ pHandle is 0 and ppustrTempDirURL is not 0 - the name of the file will be returned,
+ the caller is responsible for opening, closing and removing the file.
+ pHandle is not 0 and ppustrTempDirURL is not 0 - a handle to the open file as well as
+ the file name will be returned, the caller is responsible for closing and removing
+ the file.
+
@param pustrDirectoryURL [in]
Specifies the full qualified URL where the temporary file should be created.
If pustrDirectoryURL is 0 the path returned by osl_getTempDirURL will be used.
@@ -1626,17 +1634,6 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
file and is responsible for removing the file, in this case
*ppustrTempFileURL must be 0 or must point to a valid rtl_uString.
- @descr
- Description of the different pHandle, ppustrTempFileURL parameter combinations.
- pHandle is 0 and ppustrTempDirURL is 0 - this combination is invalid
- pHandle is not 0 and ppustrTempDirURL is 0 - a handle to the open file
- will be returned on success and the file will be automatically removed on close.
- pHandle is 0 and ppustrTempDirURL is not 0 - the name of the file will be returned,
- the caller is responsible for opening, closing and removing the file.
- pHandle is not 0 and ppustrTempDirURL is not 0 - a handle to the open file as well as
- the file name will be returned, the caller is responsible for closing and removing
- the file.
-
@return
osl_File_E_None on success
osl_File_E_INVAL the format of the parameter is invalid
diff --git a/sal/inc/osl/file.hxx b/sal/inc/osl/file.hxx
index b02ce853c91e..e64e2f0aac71 100644
--- a/sal/inc/osl/file.hxx
+++ b/sal/inc/osl/file.hxx
@@ -26,8 +26,6 @@
*
************************************************************************/
-/** @HTML */
-
#ifndef _OSL_FILE_HXX_
#define _OSL_FILE_HXX_
diff --git a/sal/inc/osl/interlck.h b/sal/inc/osl/interlck.h
index 23557f934ffd..b56e8bd3a361 100644
--- a/sal/inc/osl/interlck.h
+++ b/sal/inc/osl/interlck.h
@@ -38,13 +38,13 @@ extern "C" {
typedef sal_Int32 oslInterlockedCount;
/** Increments the count variable addressed by pCount.
- @param Address of counter variable
+ @param pCount Address of counter variable
@return The result of the operation is zero, the value of the count variable.
*/
SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_incrementInterlockedCount(oslInterlockedCount* pCount);
/** Decrement the count variable addressed by pCount.
- @param Address of counter variable
+ @param pCount Address of counter variable
@return The result of the operation is the new value is of the count variable.
*/
SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_decrementInterlockedCount(oslInterlockedCount* pCount);
diff --git a/sal/inc/osl/module.h b/sal/inc/osl/module.h
index 7d00284d5843..36a7bfabf262 100644
--- a/sal/inc/osl/module.h
+++ b/sal/inc/osl/module.h
@@ -26,8 +26,6 @@
*
************************************************************************/
-/** @HTML */
-
#ifndef _OSL_MODULE_H_
#define _OSL_MODULE_H_
@@ -71,12 +69,14 @@ typedef void ( SAL_CALL *oslGenericFunction )( void );
/** Load a shared library or module.
@param strModuleName denotes the name of the module to be loaded.
+ @param nRtldMode denotes the mode.
@return NULL if the module could not be loaded, otherwise a handle to the module.
*/
SAL_DLLPUBLIC oslModule SAL_CALL osl_loadModule(rtl_uString *strModuleName, sal_Int32 nRtldMode);
/** Load a shared library or module.
@param pModuleName denotes the name of the module to be loaded.
+ @param nRtldMode denotes the mode.
@return NULL if the module could not be loaded, otherwise a handle to the module.
@since UDK 3.6
*/
@@ -190,7 +190,7 @@ SAL_DLLPUBLIC oslGenericFunction SAL_CALL osl_getFunctionSymbol(
@param Module
[in] a module handle as returned by osl_loadModule or osl_getModuleHandle
- @param pFunctionSymbolName
+ @param pSymbol
[in] Name of the function that will be looked up.
@return
diff --git a/sal/inc/osl/module.hxx b/sal/inc/osl/module.hxx
index 3ece623d1aa9..c8d39a2ed6ac 100644
--- a/sal/inc/osl/module.hxx
+++ b/sal/inc/osl/module.hxx
@@ -26,8 +26,6 @@
*
************************************************************************/
-/** @HTML */
-
#ifndef _OSL_MODULE_HXX_
#define _OSL_MODULE_HXX_
diff --git a/sal/inc/osl/profile.h b/sal/inc/osl/profile.h
index 28e9be4cbba6..bc4b8ffe4ead 100644
--- a/sal/inc/osl/profile.h
+++ b/sal/inc/osl/profile.h
@@ -118,7 +118,6 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileIdent(
/** Deprecated API.
Acquire the mutex, block if already acquired by another thread.
- @param Profile handle to a opened profile.
@return False if section or entry could not be found.
@deprecated
*/
@@ -128,7 +127,6 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_removeProfileEntry(
/** Deprecated API.
Get all entries belonging to the specified section.
- @param Profile handle to a opened profile.
@return Pointer to a array of pointers.
@deprecated
*/
@@ -138,7 +136,6 @@ SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSectionEntries(
/** Deprecated API.
Get all section entries
- @param Profile handle to a opened profile.
@return Pointer to a array of pointers.
@deprecated
*/
diff --git a/sal/inc/osl/security.h b/sal/inc/osl/security.h
index 2b91321ec2fc..ed9d9b5e45ab 100644
--- a/sal/inc/osl/security.h
+++ b/sal/inc/osl/security.h
@@ -61,9 +61,9 @@ SAL_DLLPUBLIC oslSecurity SAL_CALL osl_getCurrentSecurity(void);
/** Deprecated API
Create a security handle for the denoted user.
Try to log in the user on the local system.
- @param strzUserName [in] denotes the name of the user to logg in.
- @param strPasswd [in] the password for this user.
- @param pSecurity [out] returns the security handle if user could be logged in.
+ @param[in] strzUserName denotes the name of the user to logg in.
+ @param[in] strPasswd the password for this user.
+ @param[out] pSecurity returns the security handle if user could be logged in.
@return osl_Security_E_None if user could be logged in, otherwise an error-code.
@see osl_freeSecurityHandle
@see osl_executeProcess
@@ -78,10 +78,10 @@ SAL_DLLPUBLIC oslSecurityError SAL_CALL osl_loginUser(
/** Create a security handle for the denoted user.
Try to log in the user on the denoted file server. On success the homedir will be
the maped drive on this server.
- @param strUserName [in] denotes the name of the user to logg in.
- @param strPasswd [in] the password for this user.
- @param strFileServer [in] denotes the file server on wich the user is logged in.
- @param pSecurity [out] returns the security handle if user could be logged in.
+ @param[in] strUserName denotes the name of the user to logg in.
+ @param[in] strPasswd the password for this user.
+ @param[in] strFileServer denotes the file server on wich the user is logged in.
+ @param[out] pSecurity returns the security handle if user could be logged in.
@return osl_Security_E_None if user could be logged in, otherwise an error-code.
@see osl_freeSecurityHandle
@see osl_executeProcess
@@ -95,46 +95,46 @@ SAL_DLLPUBLIC oslSecurityError SAL_CALL osl_loginUserOnFileServer(
);
/** Query if the user who is denotes by this security has administrator rigths.
- @param Security [in] the security handle for th user.
+ @param[in] Security the security handle for th user.
@return True, if the user has adminsitrator rights, otherwise false.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isAdministrator(
oslSecurity Security);
/** Free the security handle, created by osl_loginUser or osl_getCurrentSecurity.
- @param Security [in] the security handle.
+ @param[in] Security the security handle.
@see osl_loginUser
*/
SAL_DLLPUBLIC void SAL_CALL osl_freeSecurityHandle(
oslSecurity Security);
/** Get the login ident for the user of this security handle.
- @param Security [in] the security handle.
- @param strIdent [out] the string that receives the ident on success.
+ @param[in] Security the security handle.
+ @param[out] strIdent the string that receives the ident on success.
@return True, if the security handle is valid, otherwise False.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getUserIdent(
oslSecurity Security, rtl_uString **strIdent);
/** Get the login name for the user of this security handle.
- @param Security [in] the security handle.
- @param pszName [out] the string that receives the user name on success.
+ @param[in] Security the security handle.
+ @param[out] strName the string that receives the user name on success.
@return True, if the security handle is valid, otherwise False.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getUserName(
oslSecurity Security, rtl_uString **strName);
/** Get the home directory of the user of this security handle.
- @param Security [in] the security handle.
- @param strDirectory [out] the string that receives the directory path on success.
+ @param[in] Security the security handle.
+ @param[out] strDirectory the string that receives the directory path on success.
@return True, if the security handle is valid, otherwise False.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getHomeDir(
oslSecurity Security, rtl_uString **strDirectory);
/** Get the directory for configuration data of the user of this security handle.
- @param Security [in] the security handle.
- @param strDirectory [out] the string that receives the directory path on success.
+ @param[in] Security the security handle.
+ @param[out] strDirectory the string that receives the directory path on success.
@return True, if the security handle is valid, otherwise False.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getConfigDir(
@@ -143,7 +143,7 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_getConfigDir(
/** Load Profile of the User
Implemented just for Windows
- @param oslSecurity Security [in] previously fetch Security of the User
+ @param[in] Security previously fetch Security of the User
@return True if the Profile could successfully loaded, False otherwise.
*/
@@ -153,7 +153,7 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_loadUserProfile(
/** Unload a User Profile
Implemented just for Windows
- @param oslSecurity Security [in] previously fetch Security of the User
+ @param[in] Security previously fetch Security of the User
@return nothing is returned!
*/
diff --git a/sal/inc/osl/security_decl.hxx b/sal/inc/osl/security_decl.hxx
index a6078ea62c8b..64664c62d916 100644
--- a/sal/inc/osl/security_decl.hxx
+++ b/sal/inc/osl/security_decl.hxx
@@ -57,8 +57,8 @@ public:
@return True, if the specified user is known by the underlying operating system,
otherwise False
*/
- inline sal_Bool SAL_CALL logonUser(const ::rtl::OUString& strName,
- const ::rtl::OUString& strPasswd);
+ inline sal_Bool SAL_CALL logonUser(const rtl::OUString& strName,
+ const rtl::OUString& strPasswd);
/** get the security information for one user.
This method will try to login the user at the denoted file server.
If a network resource named \\server\username exists and this resource
@@ -69,37 +69,37 @@ public:
@return True, if the specified user is known by file server and the
could be connected, otherwise False
*/
- inline sal_Bool SAL_CALL logonUser(const ::rtl::OUString & strName,
- const ::rtl::OUString & strPasswd,
- const ::rtl::OUString & strFileServer);
+ inline sal_Bool SAL_CALL logonUser(const rtl::OUString & strName,
+ const rtl::OUString & strPasswd,
+ 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
@return True, if any user is successfuly logged in, otherwise False
*/
- inline sal_Bool SAL_CALL getUserIdent( ::rtl::OUString& strIdent) const;
+ 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
@return True, if any user is successfuly logged in, otherwise False
*/
- inline sal_Bool SAL_CALL getUserName( ::rtl::OUString& strName) const;
+ 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
*/
- inline sal_Bool SAL_CALL getHomeDir( ::rtl::OUString& strDirectory) const;
+ 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
@return True, if any user is successfuly logged in, otherwise False
*/
- inline sal_Bool SAL_CALL getConfigDir( ::rtl::OUString & strDirectory) const;
+ inline sal_Bool SAL_CALL getConfigDir( rtl::OUString & strDirectory) const;
/** Query if the user who is logged inhas administrator rigths.
@return True, if the user has administrator rights, otherwise false.
diff --git a/sal/inc/osl/socket.h b/sal/inc/osl/socket.h
index 1e81bb823090..87df6721c3d2 100644
--- a/sal/inc/osl/socket.h
+++ b/sal/inc/osl/socket.h
@@ -44,10 +44,6 @@ extern "C" {
#define OSL_INVALID_PORT (-1)
#define OSL_INVALID_IPX_SOCKET_NO 0xffffffff
-/**@HTML
-
-*/
-
/**
Opaque datatype SocketAddr.
*/
diff --git a/sal/inc/osl/socket_decl.hxx b/sal/inc/osl/socket_decl.hxx
index 6376c1bc3613..38d024218756 100644
--- a/sal/inc/osl/socket_decl.hxx
+++ b/sal/inc/osl/socket_decl.hxx
@@ -33,8 +33,6 @@
#include <rtl/ustring.hxx>
#include <rtl/byteseq.hxx>
-/** @HTML
- */
namespace osl
{
enum __osl_socket_NoCopy { SAL_NO_COPY };
diff --git a/sal/inc/rtl/allocator.hxx b/sal/inc/rtl/allocator.hxx
index c19d8d2cb3e2..7a3ac10a1f30 100644
--- a/sal/inc/rtl/allocator.hxx
+++ b/sal/inc/rtl/allocator.hxx
@@ -37,6 +37,8 @@
#include <cstddef>
+/// @cond INTERNAL
+
//######################################################
// This is no general purpose STL allocator but one
// necessary to use STL for some implementation but
@@ -49,7 +51,6 @@
namespace rtl {
-/** @internal */
template<class T>
class Allocator
{
@@ -156,14 +157,12 @@ public:
// references above) that's why the operators below
// return always true or false
-/** @internal */
template<class T, class U>
inline bool operator== (const Allocator<T>&, const Allocator<U>&) SAL_THROW(())
{
return true;
}
-/** @internal */
template<class T, class U>
inline bool operator!= (const Allocator<T>&, const Allocator<U>&) SAL_THROW(())
{
@@ -172,16 +171,12 @@ inline bool operator!= (const Allocator<T>&, const Allocator<U>&) SAL_THROW(())
} /* namespace rtl */
-//######################################################
/** REQUIRED BY STLPort (see stlport '_alloc.h'):
Hack for compilers that do not support member
template classes (e.g. MSVC 6)
-
- @internal
*/
namespace _STL
{
- /** @internal */
template<class T, class U>
inline ::rtl::Allocator<U> & __stl_alloc_rebind (::rtl::Allocator<T> & a, U const *)
{
@@ -189,6 +184,8 @@ namespace _STL
}
}
+/// @endcond
+
#endif /* INCLUDED_RTL_ALLOCATOR_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sal/inc/rtl/bootstrap.h b/sal/inc/rtl/bootstrap.h
index a88b5ad9c0bc..3f89bde31d31 100644
--- a/sal/inc/rtl/bootstrap.h
+++ b/sal/inc/rtl/bootstrap.h
@@ -35,7 +35,6 @@ extern "C" {
#endif
/**
- @HTML
@file
The described concept provides a platform independent way to access
diff --git a/sal/inc/rtl/bootstrap.hxx b/sal/inc/rtl/bootstrap.hxx
index dca3e84ce4c8..874ce5e763e6 100644
--- a/sal/inc/rtl/bootstrap.hxx
+++ b/sal/inc/rtl/bootstrap.hxx
@@ -36,9 +36,7 @@ namespace rtl
{
void * _handle;
- /** @internal */
inline Bootstrap( Bootstrap const & ); // not impl
- /** @internal */
inline Bootstrap & operator = ( Bootstrap const & ); // not impl
public:
@@ -74,9 +72,9 @@ namespace rtl
/** Sets a bootstrap parameter.
- @param pName
+ @param name
name of bootstrap parameter
- @param pValue
+ @param value
value of bootstrap parameter
@see rtl_bootstrap_set()
diff --git a/sal/inc/rtl/byteseq.h b/sal/inc/rtl/byteseq.h
index ee321c24e7b7..93e85ddcd500 100644
--- a/sal/inc/rtl/byteseq.h
+++ b/sal/inc/rtl/byteseq.h
@@ -166,24 +166,21 @@ enum __ByteSequence_NoAcquire
class ByteSequence
{
/** sequence handle
- @internal
*/
sal_Sequence * _pSequence;
public:
+ /// @cond INTERNAL
// these are here to force memory de/allocation to sal lib.
- /** @internal */
inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
- /** @internal */
inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
- /** @internal */
inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
- /** @internal */
inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () )
{}
+ /// @endcond
/** Default constructor: Creates an empty sequence.
*/
diff --git a/sal/inc/rtl/instance.hxx b/sal/inc/rtl/instance.hxx
index bcb1791e364b..943a449413a7 100644
--- a/sal/inc/rtl/instance.hxx
+++ b/sal/inc/rtl/instance.hxx
@@ -379,9 +379,9 @@ namespace rtl {
...
</pre>
- @tplparam T
+ @tparam T
variable's type
- @tplparam Unique
+ @tparam Unique
Implementation trick to make the inner static holder unique,
using the outer class
(the one that derives from this base class)
@@ -439,9 +439,9 @@ private:
...
</pre>
- @tplparam T
+ @tparam T
variable's type
- @tplparam Unique
+ @tparam Unique
Implementation trick to make the inner static holder unique,
using the outer class
(the one that derives from this base class)
@@ -523,9 +523,9 @@ private:
/** Helper class for a late-initialized static aggregate, e.g. an array,
implementing the double-checked locking pattern correctly.
- @tplparam T
+ @tparam T
aggregate's element type
- @tplparam InitAggregate
+ @tparam InitAggregate
initializer functor class
*/
#if (__GNUC__ >= 4)
@@ -580,16 +580,16 @@ public:
...
</pre>
- @tplparam T
+ @tparam T
variable's type
- @tplparam InitData
+ @tparam InitData
initializer functor class
- @tplparam Unique
+ @tparam Unique
Implementation trick to make the inner static holder unique,
using the outer class
(the one that derives from this base class).
Default is InitData (common practice).
- @tplparam Data
+ @tparam Data
Initializer functor's return type.
Default is T (common practice).
*/
diff --git a/sal/inc/rtl/math.h b/sal/inc/rtl/math.h
index c2c087d3474a..77f29b129b23 100644
--- a/sal/inc/rtl/math.h
+++ b/sal/inc/rtl/math.h
@@ -59,9 +59,9 @@ enum rtl_math_StringFormat
*/
rtl_math_StringFormat_Automatic,
- /** @internal
- */
+ /** @cond INTERNAL */
rtl_math_StringFormat_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
+ /** @endcond */
};
/** Status for rtl_math_stringToDouble and rtl_math_uStringToDouble.
@@ -76,9 +76,9 @@ enum rtl_math_ConversionStatus
*/
rtl_math_ConversionStatus_OutOfRange,
- /** @internal
- */
+ /** @cond INTERNAL */
rtl_math_ConversionStatus_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
+ /** @endcond */
};
/** Rounding modes for rtl_math_round.
@@ -117,9 +117,9 @@ enum rtl_math_RoundingMode
*/
rtl_math_RoundingMode_HalfEven,
- /** @internal
- */
+ /** @cond INTERNAL */
rtl_math_RoundingMode_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
+ /** @endcond */
};
/** Special decimal places constants for rtl_math_doubleToString and
diff --git a/sal/inc/rtl/math.hxx b/sal/inc/rtl/math.hxx
index 14581ee0b2f9..2018308f9c6c 100644
--- a/sal/inc/rtl/math.hxx
+++ b/sal/inc/rtl/math.hxx
@@ -251,7 +251,7 @@ inline double acosh(double fValue)
/** Test equality of two values with an accuracy of the magnitude of the
given values scaled by 2^-48 (4 bits roundoff stripped).
- @ATTENTION
+ @attention
approxEqual( value!=0.0, 0.0 ) _never_ yields true.
*/
inline bool approxEqual(double a, double b)
diff --git a/sal/inc/rtl/ref.hxx b/sal/inc/rtl/ref.hxx
index abe96e947eed..83bfc60b41eb 100644
--- a/sal/inc/rtl/ref.hxx
+++ b/sal/inc/rtl/ref.hxx
@@ -229,14 +229,15 @@ public:
}
};
-/** @internal
- Enables boost::mem_fn and boost::bind to recognize Reference.
+/// @cond INTERNAL
+/** Enables boost::mem_fn and boost::bind to recognize Reference.
*/
template <typename T>
inline T * get_pointer( Reference<T> const& r )
{
return r.get();
}
+/// @endcond
} // namespace rtl
diff --git a/sal/inc/rtl/strbuf.h b/sal/inc/rtl/strbuf.h
index deebd89d7d16..50205154b0df 100644
--- a/sal/inc/rtl/strbuf.h
+++ b/sal/inc/rtl/strbuf.h
@@ -35,8 +35,7 @@
extern "C" {
#endif
-/** @HTML
- Allocates a new <code>String</code> that contains characters from
+/** Allocates a new <code>String</code> that contains characters from
the character array argument.
The <code>count</code> argument specifies
diff --git a/sal/inc/rtl/strbuf.hxx b/sal/inc/rtl/strbuf.hxx
index 2f92b0fc23c3..4df6e3be4fa6 100644
--- a/sal/inc/rtl/strbuf.hxx
+++ b/sal/inc/rtl/strbuf.hxx
@@ -41,9 +41,7 @@
namespace rtl
{
-/** @HTML
-
- A string buffer implements a mutable sequence of characters.
+/** A string buffer implements a mutable sequence of characters.
<p>
String buffers are safe for use by multiple threads. The methods
are synchronized where necessary so that all the operations on any
diff --git a/sal/inc/rtl/string.h b/sal/inc/rtl/string.h
index 7b2354711f5a..9b5f2944a637 100644
--- a/sal/inc/rtl/string.h
+++ b/sal/inc/rtl/string.h
@@ -781,9 +781,8 @@ SAL_DLLPUBLIC double SAL_CALL rtl_str_toDouble(
# pragma pack(push, 8)
#endif
+/** @cond INTERNAL */
/** The implementation of a byte string.
-
- @internal
*/
typedef struct _rtl_String
{
@@ -791,6 +790,7 @@ typedef struct _rtl_String
sal_Int32 length;
sal_Char buffer[1];
} rtl_String;
+/** @endcond */
#if defined(SAL_W32)
#pragma pack(pop)
diff --git a/sal/inc/rtl/string.hxx b/sal/inc/rtl/string.hxx
index 0db8341a8930..ccd96b9656a4 100644
--- a/sal/inc/rtl/string.hxx
+++ b/sal/inc/rtl/string.hxx
@@ -75,14 +75,13 @@ namespace rtl
class OString
{
public:
- /** @internal */
+ /// @cond INTERNAL
rtl_String * pData;
+ /// @endcond
private:
- /** @internal */
class DO_NOT_ACQUIRE;
- /** @internal */
OString( rtl_String * value, DO_NOT_ACQUIRE * )
{
pData = value;
diff --git a/sal/inc/rtl/unload.h b/sal/inc/rtl/unload.h
index 5e70690342b5..9479f82ceb90 100644
--- a/sal/inc/rtl/unload.h
+++ b/sal/inc/rtl/unload.h
@@ -33,7 +33,6 @@
#include <osl/interlck.h>
#include <osl/module.h>
-///@HTML
/** @file
The API enables an effective way of unloading libraries in a centralized way.
The mechanism ensures that used libraries are not unloaded. This prevents
diff --git a/sal/inc/rtl/uri.h b/sal/inc/rtl/uri.h
index d0f5e0009971..3651db002bfa 100644
--- a/sal/inc/rtl/uri.h
+++ b/sal/inc/rtl/uri.h
@@ -59,7 +59,7 @@ typedef enum
*/
rtl_UriCharClassNone,
- /** The RFC 2732 <uric> char class.
+ /** The RFC 2732 @<uric> char class.
@descr
The 'valid' characters are !$&'()*+,-./:;=?@[]_~ plus digits and
@@ -67,35 +67,35 @@ typedef enum
*/
rtl_UriCharClassUric,
- /** The RFC 2396 <uric_no_slash> char class.
+ /** The RFC 2396 @<uric_no_slash> char class.
@descr
The 'valid' characters are !$&'()*+,-.:;=?@_~ plus digits and letters.
*/
rtl_UriCharClassUricNoSlash,
- /** The RFC 2396 <rel_segment> char class.
+ /** The RFC 2396 @<rel_segment> char class.
@descr
The 'valid' characters are !$&'()*+,-.;=@_~ plus digits and letters.
*/
rtl_UriCharClassRelSegment,
- /** The RFC 2396 <reg_name> char class.
+ /** The RFC 2396 @<reg_name> char class.
@descr
The 'valid' characters are !$&'()*+,-.:;=@_~ plus digits and letters.
*/
rtl_UriCharClassRegName,
- /** The RFC 2396 <userinfo> char class.
+ /** The RFC 2396 @<userinfo> char class.
@descr
The 'valid' characters are !$&'()*+,-.:;=_~ plus digits and letters.
*/
rtl_UriCharClassUserinfo,
- /** The RFC 2396 <pchar> char class.
+ /** The RFC 2396 @<pchar> char class.
@descr
The 'valid' characters are !$&'()*+,-.:=@_~ plus digits and letters.
@@ -304,7 +304,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uriDecode(
/** Convert a relative URI reference into an absolute one.
- A URI reference is a URI plus an optional <"#" fragment> part.
+ A URI reference is a URI plus an optional @<"#" fragment> part.
This function uses the algorithm described in RFC 2396, section 5.2, with
the following clarifications: (1) Backwards-compatible relative URIs
@@ -323,7 +323,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uriDecode(
An absolute, hierarchical URI reference that serves as the base URI. If it
has to be inspected (i.e., pRelUriRef is not an absolute URI already), and
if it either is not an absolute URI (i.e., does not begin with a
- <scheme ":"> part) or has a path that is non-empty but does not start
+ @<scheme ":"> part) or has a path that is non-empty but does not start
with "/", an exception will be signaled.
@param pRelUriRef
diff --git a/sal/inc/rtl/uri.hxx b/sal/inc/rtl/uri.hxx
index c4bb81bd0e02..40bb9ad85124 100644
--- a/sal/inc/rtl/uri.hxx
+++ b/sal/inc/rtl/uri.hxx
@@ -77,20 +77,16 @@ public:
rtl::OUString const & rBaseUriRef, rtl::OUString const & rRelUriRef);
private:
- /** not implemented
- @internal */
+ /** not implemented */
Uri();
- /** not implemented
- @internal */
+ /** not implemented */
Uri(Uri &);
- /** not implemented
- @internal */
+ /** not implemented */
~Uri();
- /** not implemented
- @internal */
+ /** not implemented */
void operator =(Uri);
};
diff --git a/sal/inc/rtl/ustrbuf.h b/sal/inc/rtl/ustrbuf.h
index bc73f2a1cd18..a37cb6e9b082 100644
--- a/sal/inc/rtl/ustrbuf.h
+++ b/sal/inc/rtl/ustrbuf.h
@@ -35,8 +35,7 @@
extern "C" {
#endif
-/** @HTML
- Allocates a new <code>String</code> that contains characters from
+/** Allocates a new <code>String</code> that contains characters from
the character array argument.
The <code>count</code> argument specifies
diff --git a/sal/inc/rtl/ustrbuf.hxx b/sal/inc/rtl/ustrbuf.hxx
index 74df4fe9beb0..de499428bc4e 100644
--- a/sal/inc/rtl/ustrbuf.hxx
+++ b/sal/inc/rtl/ustrbuf.hxx
@@ -40,8 +40,7 @@
namespace rtl
{
-/** @HTML
- A string buffer implements a mutable sequence of characters.
+/** A string buffer implements a mutable sequence of characters.
<p>
String buffers are safe for use by multiple threads. The methods
are synchronized where necessary so that all the operations on any
@@ -576,7 +575,7 @@ public:
string buffer.
@param offset the offset.
- @param ch a character array.
+ @param str a character array.
@return this string buffer.
*/
OUStringBuffer & insert( sal_Int32 offset, const sal_Unicode * str )
@@ -598,7 +597,7 @@ public:
string buffer.
@param offset the offset.
- @param ch a character array.
+ @param str a character array.
@param len the number of characters to append.
@return this string buffer.
*/
@@ -645,7 +644,7 @@ public:
string buffer.
@param offset the offset.
- @param ch a <code>char</code>.
+ @param c a <code>char</code>.
@return this string buffer.
@since LibreOffice 3.6
@@ -669,7 +668,7 @@ public:
string buffer.
@param offset the offset.
- @param ch a <code>char</code>.
+ @param c a <code>char</code>.
@return this string buffer.
*/
OUStringBuffer & insert(sal_Int32 offset, sal_Unicode c)
@@ -691,7 +690,8 @@ public:
string buffer.
@param offset the offset.
- @param b an <code>sal_Int32</code>.
+ @param i an <code>sal_Int32</code>.
+ @param radix the radix.
@return this string buffer.
@exception StringIndexOutOfBoundsException if the offset is invalid.
*/
@@ -715,7 +715,8 @@ public:
string buffer.
@param offset the offset.
- @param b a <code>long</code>.
+ @param l a <code>long</code>.
+ @param radix the radix.
@return this string buffer.
@exception StringIndexOutOfBoundsException if the offset is invalid.
*/
@@ -739,7 +740,7 @@ public:
string buffer.
@param offset the offset.
- @param b a <code>float</code>.
+ @param f a <code>float</code>.
@return this string buffer.
@exception StringIndexOutOfBoundsException if the offset is invalid.
*/
@@ -763,7 +764,7 @@ public:
string buffer.
@param offset the offset.
- @param b a <code>double</code>.
+ @param d a <code>double</code>.
@return this string buffer.
@exception StringIndexOutOfBoundsException if the offset is invalid.
*/
diff --git a/sal/inc/rtl/ustring.h b/sal/inc/rtl/ustring.h
index c77b343d1d23..699d3a0e7309 100644
--- a/sal/inc/rtl/ustring.h
+++ b/sal/inc/rtl/ustring.h
@@ -1111,9 +1111,8 @@ SAL_DLLPUBLIC double SAL_CALL rtl_ustr_toDouble(
#pragma pack(push, 4)
#endif
+/** @cond INTERNAL */
/** The implementation of a Unicode string.
-
- @internal
*/
typedef struct _rtl_uString
{
@@ -1121,6 +1120,7 @@ typedef struct _rtl_uString
sal_Int32 length;
sal_Unicode buffer[1];
} rtl_uString;
+/** @endcond */
#if defined(SAL_W32)
#pragma pack(pop)
diff --git a/sal/inc/rtl/ustring.hxx b/sal/inc/rtl/ustring.hxx
index 868f6dd043cd..21bd99d87e07 100644
--- a/sal/inc/rtl/ustring.hxx
+++ b/sal/inc/rtl/ustring.hxx
@@ -76,14 +76,13 @@ namespace rtl
class OUString
{
public:
- /** @internal */
+ /// @cond INTERNAL
rtl_uString * pData;
+ /// @endcond
private:
- /** @internal */
class DO_NOT_ACQUIRE{};
- /** @internal */
OUString( rtl_uString * value, DO_NOT_ACQUIRE * )
{
pData = value;
@@ -123,10 +122,11 @@ public:
/** New OUString from OUString data without acquiring it. Takeover of ownership.
+ The SAL_NO_ACQUIRE dummy parameter is only there to distinguish this
+ from other constructors.
+
@param str
OUString data
- @param dummy
- SAL_NO_ACQUIRE to distinguish from other ctors
*/
inline OUString( rtl_uString * str, __sal_NoAcquire ) SAL_THROW( () )
{ pData = str; }
@@ -666,7 +666,8 @@ public:
equal as asciiStrLength.
This function can't be used for language specific comparison.
- @param str the object (substring) to be compared.
+ @param asciiStr the object (substring) to be compared.
+ @param asciiStrLength the length of asciiStr.
@param fromIndex the index to start the comparion from.
The index must be greater or equal than 0
and less or equal as the string length.
@@ -715,7 +716,7 @@ public:
@param asciiStr a sequence of at least asciiStrLength ASCII characters
(bytes in the range 0x00--0x7F)
- @param asciiStrLen the length of asciiStr; must be non-negative
+ @param asciiStrLength the length of asciiStr; must be non-negative
@return true if this string ends with asciiStr; otherwise, false is
returned
@@ -736,7 +737,7 @@ public:
@param asciiStr a sequence of at least asciiStrLength ASCII characters
(bytes in the range 0x00--0x7F)
- @param asciiStrLen the length of asciiStr; must be non-negative
+ @param asciiStrLength the length of asciiStr; must be non-negative
@return true if this string ends with asciiStr, ignoring the case of ASCII
letters ("A"--"Z" and "a"--"z"); otherwise, false is returned
*/
diff --git a/sal/inc/rtl/uuid.h b/sal/inc/rtl/uuid.h
index 0c78e6833d07..9d831e0f9146 100644
--- a/sal/inc/rtl/uuid.h
+++ b/sal/inc/rtl/uuid.h
@@ -33,7 +33,6 @@
#include <rtl/string.h>
/**
- @HTML
@file
Specification (from draft-leach-uuids-guids-01.txt )
diff --git a/sal/inc/sal/detail/log.h b/sal/inc/sal/detail/log.h
index 74292b76a3ee..ce9ac934e151 100644
--- a/sal/inc/sal/detail/log.h
+++ b/sal/inc/sal/detail/log.h
@@ -34,7 +34,7 @@
#include "sal/types.h"
-/** @internal */
+/** @cond INTERNAL */
/* This header makes available replacements working in both C and C++ for the
obsolete osl/diagnose.h functionality that in turn is used from both C and
@@ -106,6 +106,8 @@ SAL_DLLPUBLIC void SAL_CALL sal_detail_logFormat(
SAL_DETAIL_ENABLE_LOG_WARN && (condition), SAL_DETAIL_LOG_LEVEL_WARN, \
area, SAL_DETAIL_WHERE, __VA_ARGS__)
+/** @endcond */
+
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sal/inc/sal/log.hxx b/sal/inc/sal/log.hxx
index 918d9d6441b5..6eb152b2f78d 100644
--- a/sal/inc/sal/log.hxx
+++ b/sal/inc/sal/log.hxx
@@ -43,12 +43,12 @@
// this code can be called from other sal code without causing endless
// recursion.
-/// @internal
+/// @cond INTERNAL
+
extern "C" SAL_DLLPUBLIC void SAL_CALL sal_detail_log(
enum sal_detail_LogLevel level, char const * area, char const * where,
char const * message);
-/// @internal
namespace sal { namespace detail {
inline void SAL_CALL log(
@@ -127,7 +127,6 @@ inline char const * unwrapStream(StreamIgnore const &) {
} }
-/// @internal
#define SAL_DETAIL_LOG_STREAM(condition, level, area, where, stream) \
do { \
if (condition) { \
@@ -147,6 +146,8 @@ inline char const * unwrapStream(StreamIgnore const &) {
} \
} while (false)
+/// @endcond
+
/** A simple macro to create a "file and line number" string.
Potentially not only useful within the log framework (where it is used