Kaydet (Commit) 8c365765 authored tarafından Stephan Bergmann's avatar Stephan Bergmann

Tweak comments

(Preventing documentation of macros via @cond ... @endcond is apparently at
least broken in Doxygen 1.8.3 and working in Doxygen 1.8.4.)

Change-Id: I2ee582119dba2c3d27db5298786d3076921af46d
üst 54054514
...@@ -163,12 +163,11 @@ public: ...@@ -163,12 +163,11 @@ public:
sal_Int32 myVal = myAny.get<sal_Int32>(); sal_Int32 myVal = myAny.get<sal_Int32>();
</pre> </pre>
Widening conversion without data loss is taken into account. Widening conversion without data loss is taken into account.
Throws a Throws a com::sun::star::uno::RuntimeException if the specified type
<type scope="com::sun::star::uno">RuntimeException</type> cannot be provided.
if the specified type cannot be provided.
@return value of specified type @return value of specified type
@exception <type scope="com::sun::star::uno">RuntimeException</type> @exception com::sun::star::uno::RuntimeException
in case the specified type cannot be provided in case the specified type cannot be provided
*/ */
template <typename T> template <typename T>
......
...@@ -48,9 +48,10 @@ namespace osl ...@@ -48,9 +48,10 @@ namespace osl
/** The SocketAddr takes over the responsibility of the handle ( which means, /** The SocketAddr takes over the responsibility of the handle ( which means,
that the handle gets destructed by the destructor of this reference) that the handle gets destructed by the destructor of this reference)
@param Addr a handle
@param nocopy use SAL_NO_COPY @param nocopy use SAL_NO_COPY
*/ */
inline SocketAddr(const oslSocketAddr , __osl_socket_NoCopy nocopy ); inline SocketAddr(const oslSocketAddr Addr, __osl_socket_NoCopy nocopy );
/** Copyconstructs the oslSocketAddr handle. /** Copyconstructs the oslSocketAddr handle.
*/ */
......
...@@ -47,6 +47,7 @@ ...@@ -47,6 +47,7 @@
namespace rtl namespace rtl
{ {
/// @cond INTERNAL
#ifdef RTL_STRING_UNITTEST #ifdef RTL_STRING_UNITTEST
#undef rtl #undef rtl
// helper macro to make functions appear more readable // helper macro to make functions appear more readable
...@@ -54,6 +55,7 @@ namespace rtl ...@@ -54,6 +55,7 @@ namespace rtl
#else #else
#define RTL_STRING_CONST_FUNCTION #define RTL_STRING_CONST_FUNCTION
#endif #endif
/// @endcond
/** A string buffer implements a mutable sequence of characters. /** A string buffer implements a mutable sequence of characters.
<p> <p>
......
...@@ -53,6 +53,7 @@ ...@@ -53,6 +53,7 @@
namespace rtl namespace rtl
{ {
/// @cond INTERNAL
#ifdef RTL_STRING_UNITTEST #ifdef RTL_STRING_UNITTEST
#undef rtl #undef rtl
// helper macro to make functions appear more readable // helper macro to make functions appear more readable
...@@ -60,6 +61,7 @@ namespace rtl ...@@ -60,6 +61,7 @@ namespace rtl
#else #else
#define RTL_STRING_CONST_FUNCTION #define RTL_STRING_CONST_FUNCTION
#endif #endif
/// @endcond
/* ======================================================================= */ /* ======================================================================= */
...@@ -1638,8 +1640,10 @@ inline std::basic_ostream<charT, traits> & operator <<( ...@@ -1638,8 +1640,10 @@ inline std::basic_ostream<charT, traits> & operator <<(
return stream << OString( concat ); return stream << OString( concat );
} }
#else #else
// non-RTL_FAST_CODE needs this to compile // non-RTL_FAST_STRING needs this to compile
/// @cond INTERNAL
typedef OString OStringLiteral; typedef OString OStringLiteral;
/// @endcond
#endif #endif
...@@ -1663,14 +1667,14 @@ struct OStringHash ...@@ -1663,14 +1667,14 @@ struct OStringHash
{ return (size_t)rString.hashCode(); } { return (size_t)rString.hashCode(); }
}; };
/** Equality functor for classic c-strings (i.e. null-terminated char* strings) */ /** Equality functor for classic c-strings (i.e., null-terminated char* strings). */
struct CStringEqual struct CStringEqual
{ {
bool operator()( const char* p1, const char* p2) const bool operator()( const char* p1, const char* p2) const
{ return rtl_str_compare(p1, p2) == 0; } { return rtl_str_compare(p1, p2) == 0; }
}; };
/** Hashing functor for classic c-strings (i.e. null-terminated char* strings) */ /** Hashing functor for classic c-strings (i.e., null-terminated char* strings). */
struct CStringHash struct CStringHash
{ {
size_t operator()(const char* p) const size_t operator()(const char* p) const
......
...@@ -2287,8 +2287,10 @@ inline std::basic_ostream<charT, traits> & operator <<( ...@@ -2287,8 +2287,10 @@ inline std::basic_ostream<charT, traits> & operator <<(
return stream << OUString( concat ); return stream << OUString( concat );
} }
#else #else
// non-RTL_FAST_CODE needs this to compile // non-RTL_FAST_STRING needs this to compile
/// @cond INTERNAL
typedef OUString OUStringLiteral; typedef OUString OUStringLiteral;
/// @endcond
#endif #endif
/** A helper to use OUStrings with hash maps. /** A helper to use OUStrings with hash maps.
......
...@@ -34,6 +34,6 @@ MACRO_EXPANSION = YES ...@@ -34,6 +34,6 @@ MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES EXPAND_ONLY_PREDEF = YES
PREDEFINED = __cplusplus \ PREDEFINED = __cplusplus \
SAL_CALL= \ SAL_CALL= \
SAL_DEPRECATED_INTERNAL= \ SAL_DEPRECATED_INTERNAL(x)= \
SAL_DEPRECATED= \ SAL_DEPRECATED(x)= \
"SAL_THROW(x)=throw x" "SAL_THROW(x)=throw x"
...@@ -30,7 +30,7 @@ ...@@ -30,7 +30,7 @@
module com { module sun { module star { module awt { module com { module sun { module star { module awt {
/** Sspecifies a provider for dialogs implementing the /** Specifies a provider for dialogs implementing the
<type scope="com::sun::star::awt">XDialog</type> interface. <type scope="com::sun::star::awt">XDialog</type> interface.
*/ */
service DialogProvider : com::sun::star::awt::XDialogProvider service DialogProvider : com::sun::star::awt::XDialogProvider
......
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