summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephan Bergmann <sbergman@redhat.com>2013-05-29 15:01:18 +0200
committerStephan Bergmann <sbergman@redhat.com>2013-05-29 15:03:01 +0200
commit8c3657658a70523005c0dbb19a691aa025da039a (patch)
treea5f561aaa3cfc8b015662a24903990975b901484
parent54054514403a3e9bc45a71b20eb5e58befbb5508 (diff)
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
-rw-r--r--include/com/sun/star/uno/Any.h7
-rw-r--r--include/osl/socket_decl.hxx3
-rw-r--r--include/rtl/strbuf.hxx2
-rw-r--r--include/rtl/string.hxx10
-rw-r--r--include/rtl/ustring.hxx4
-rw-r--r--odk/pack/gendocu/Doxyfile4
-rw-r--r--offapi/com/sun/star/awt/DialogProvider.idl2
7 files changed, 20 insertions, 12 deletions
diff --git a/include/com/sun/star/uno/Any.h b/include/com/sun/star/uno/Any.h
index f1d03e8709b5..b4ead8977596 100644
--- a/include/com/sun/star/uno/Any.h
+++ b/include/com/sun/star/uno/Any.h
@@ -163,12 +163,11 @@ public:
sal_Int32 myVal = myAny.get<sal_Int32>();
</pre>
Widening conversion without data loss is taken into account.
- Throws a
- <type scope="com::sun::star::uno">RuntimeException</type>
- if the specified type cannot be provided.
+ Throws a com::sun::star::uno::RuntimeException if the specified type
+ cannot be provided.
@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
*/
template <typename T>
diff --git a/include/osl/socket_decl.hxx b/include/osl/socket_decl.hxx
index f51cca12e4c3..2bcbd6cbd575 100644
--- a/include/osl/socket_decl.hxx
+++ b/include/osl/socket_decl.hxx
@@ -48,9 +48,10 @@ namespace osl
/** The SocketAddr takes over the responsibility of the handle ( which means,
that the handle gets destructed by the destructor of this reference)
+ @param Addr a handle
@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.
*/
diff --git a/include/rtl/strbuf.hxx b/include/rtl/strbuf.hxx
index 9ebd495239cd..d04f828d3232 100644
--- a/include/rtl/strbuf.hxx
+++ b/include/rtl/strbuf.hxx
@@ -47,6 +47,7 @@
namespace rtl
{
+/// @cond INTERNAL
#ifdef RTL_STRING_UNITTEST
#undef rtl
// helper macro to make functions appear more readable
@@ -54,6 +55,7 @@ namespace rtl
#else
#define RTL_STRING_CONST_FUNCTION
#endif
+/// @endcond
/** A string buffer implements a mutable sequence of characters.
<p>
diff --git a/include/rtl/string.hxx b/include/rtl/string.hxx
index 6cb69c6479b0..9432b7449562 100644
--- a/include/rtl/string.hxx
+++ b/include/rtl/string.hxx
@@ -53,6 +53,7 @@
namespace rtl
{
+/// @cond INTERNAL
#ifdef RTL_STRING_UNITTEST
#undef rtl
// helper macro to make functions appear more readable
@@ -60,6 +61,7 @@ namespace rtl
#else
#define RTL_STRING_CONST_FUNCTION
#endif
+/// @endcond
/* ======================================================================= */
@@ -1638,8 +1640,10 @@ inline std::basic_ostream<charT, traits> & operator <<(
return stream << OString( concat );
}
#else
-// non-RTL_FAST_CODE needs this to compile
+// non-RTL_FAST_STRING needs this to compile
+/// @cond INTERNAL
typedef OString OStringLiteral;
+/// @endcond
#endif
@@ -1663,14 +1667,14 @@ struct OStringHash
{ 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
{
bool operator()( const char* p1, const char* p2) const
{ 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
{
size_t operator()(const char* p) const
diff --git a/include/rtl/ustring.hxx b/include/rtl/ustring.hxx
index f776da35d408..112486d3bde2 100644
--- a/include/rtl/ustring.hxx
+++ b/include/rtl/ustring.hxx
@@ -2287,8 +2287,10 @@ inline std::basic_ostream<charT, traits> & operator <<(
return stream << OUString( concat );
}
#else
-// non-RTL_FAST_CODE needs this to compile
+// non-RTL_FAST_STRING needs this to compile
+/// @cond INTERNAL
typedef OUString OUStringLiteral;
+/// @endcond
#endif
/** A helper to use OUStrings with hash maps.
diff --git a/odk/pack/gendocu/Doxyfile b/odk/pack/gendocu/Doxyfile
index 75460486cdd3..26c8893d6624 100644
--- a/odk/pack/gendocu/Doxyfile
+++ b/odk/pack/gendocu/Doxyfile
@@ -34,6 +34,6 @@ MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = __cplusplus \
SAL_CALL= \
- SAL_DEPRECATED_INTERNAL= \
- SAL_DEPRECATED= \
+ SAL_DEPRECATED_INTERNAL(x)= \
+ SAL_DEPRECATED(x)= \
"SAL_THROW(x)=throw x"
diff --git a/offapi/com/sun/star/awt/DialogProvider.idl b/offapi/com/sun/star/awt/DialogProvider.idl
index e259ad7e916c..72886854a181 100644
--- a/offapi/com/sun/star/awt/DialogProvider.idl
+++ b/offapi/com/sun/star/awt/DialogProvider.idl
@@ -30,7 +30,7 @@
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.
*/
service DialogProvider : com::sun::star::awt::XDialogProvider