diff options
Diffstat (limited to 'cppu/inc/com/sun')
-rw-r--r-- | cppu/inc/com/sun/star/uno/Any.h | 19 | ||||
-rw-r--r-- | cppu/inc/com/sun/star/uno/Reference.h | 13 | ||||
-rw-r--r-- | cppu/inc/com/sun/star/uno/Sequence.h | 22 | ||||
-rw-r--r-- | cppu/inc/com/sun/star/uno/Sequence.hxx | 3 | ||||
-rw-r--r-- | cppu/inc/com/sun/star/uno/Type.h | 46 |
5 files changed, 56 insertions, 47 deletions
diff --git a/cppu/inc/com/sun/star/uno/Any.h b/cppu/inc/com/sun/star/uno/Any.h index eb29273c16aa..a2fe589682f4 100644 --- a/cppu/inc/com/sun/star/uno/Any.h +++ b/cppu/inc/com/sun/star/uno/Any.h @@ -55,19 +55,17 @@ namespace uno class Any : public uno_Any { 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: Any holds no value; its type is void. */ @@ -263,7 +261,7 @@ private: /** Template function to generically construct an any from a C++ value. - @tplparam C value type + @tparam C value type @param value a value @return an any */ @@ -279,7 +277,7 @@ class Type; /** Template binary <<= operator to set the value of an any. - @tplparam C value type + @tparam C value type @param rAny destination any (left side) @param value source value (right side) */ @@ -294,7 +292,7 @@ inline void SAL_CALL operator <<= ( Any & rAny, bool const & value ) If the any does not contain a value that can be assigned without data loss, then this operation will fail returning false. - @tplparam C value type + @tparam C value type @param rAny source any (left side) @param value destination value (right side) @return true if assignment was possible without data loss @@ -307,7 +305,7 @@ inline sal_Bool SAL_CALL operator >>= ( const Any & rAny, C & value ) SAL_THROW( This operator can be implemented as template member function, if all supported compilers can cope with template member functions. - @tplparam C value type + @tparam C value type @param rAny another any (left side) @param value a value (right side) @return true if values are equal, false otherwise @@ -319,7 +317,7 @@ inline sal_Bool SAL_CALL operator == ( const Any & rAny, const C & value ) SAL_T This operator can be implemented as template member function, if all supported compilers can cope with template member functions. - @tplparam C value type + @tparam C value type @param rAny another any (left side) @param value a value (right side) @return true if values are unequal, false otherwise @@ -373,7 +371,8 @@ inline sal_Bool SAL_CALL operator == ( const Any & rAny, const BaseReference & v There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type any */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::com::sun::star::uno::Any * ) SAL_THROW( () ) diff --git a/cppu/inc/com/sun/star/uno/Reference.h b/cppu/inc/com/sun/star/uno/Reference.h index 071cadcfde7b..d3611ac73105 100644 --- a/cppu/inc/com/sun/star/uno/Reference.h +++ b/cppu/inc/com/sun/star/uno/Reference.h @@ -164,7 +164,7 @@ enum UnoReference_QueryThrow */ UNO_REF_QUERY_THROW }; -/** Enum defining UNO_SET_THROW for throwing if attempts are made to assign a <NULL/> +/** Enum defining UNO_SET_THROW for throwing if attempts are made to assign a null interface @since UDK 3.2.8 @@ -238,19 +238,17 @@ class Reference : public BaseReference } 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 /** Destructor: Releases interface if set. */ @@ -517,14 +515,15 @@ public: inline static Reference< interface_type > SAL_CALL query( XInterface * pInterface ) SAL_THROW( (RuntimeException) ); }; -/** @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 } } diff --git a/cppu/inc/com/sun/star/uno/Sequence.h b/cppu/inc/com/sun/star/uno/Sequence.h index 68abc9d24748..13a4bf008352 100644 --- a/cppu/inc/com/sun/star/uno/Sequence.h +++ b/cppu/inc/com/sun/star/uno/Sequence.h @@ -57,41 +57,39 @@ namespace uno so the sequence keeps a handle to its data. To keep value semantics, copies are only generated if the sequence is to be modified (new handle). - @tplparam E element type of sequence + @tparam E element type of sequence */ template< class E > class Sequence { /** sequence handle - @internal */ uno_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( () ) {} /** Static pointer to typelib type of sequence. Don't use directly, call getCppuType(). - @internal */ static typelib_TypeDescriptionReference * s_pType; + /// @endcond + /** typedefs the element type of the sequence */ typedef E ElementType; @@ -252,8 +250,9 @@ inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence( There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @tplparam E element type of sequence - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + + @tparam E element type of sequence @return type of IDL sequence */ template< class E > @@ -268,7 +267,7 @@ SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< E > * ) @attention the given element type must be the same as the template argument type! - @tplparam E element type of sequence + @tparam E element type of sequence @param rElementType element type of sequence @return type of IDL sequence */ @@ -280,7 +279,8 @@ SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType ) /** Gets the meta type of IDL sequence< char >. This function has been introduced due to ambiguities with unsigned short. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL sequence< char > */ inline const ::com::sun::star::uno::Type & diff --git a/cppu/inc/com/sun/star/uno/Sequence.hxx b/cppu/inc/com/sun/star/uno/Sequence.hxx index 8a9b43d1339e..c86c629df7bc 100644 --- a/cppu/inc/com/sun/star/uno/Sequence.hxx +++ b/cppu/inc/com/sun/star/uno/Sequence.hxx @@ -45,9 +45,10 @@ namespace star namespace uno { -//______________________________________________________________________________ +/// @cond INTERNAL template< class E > typelib_TypeDescriptionReference * Sequence< E >::s_pType = 0; +/// @endcond //______________________________________________________________________________ template< class E > diff --git a/cppu/inc/com/sun/star/uno/Type.h b/cppu/inc/com/sun/star/uno/Type.h index 6490fa4ab7f1..2072d6accc82 100644 --- a/cppu/inc/com/sun/star/uno/Type.h +++ b/cppu/inc/com/sun/star/uno/Type.h @@ -66,24 +66,21 @@ enum UnoType_NoAcquire class Type { /** the C typelib reference pointer - @internal */ typelib_TypeDescriptionReference * _pType; 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: Type is set to void. */ @@ -222,7 +219,8 @@ public: There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type "type" */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::com::sun::star::uno::Type * ) SAL_THROW( () ); @@ -252,7 +250,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getBooleanCppuType() SAL_THR There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type boolean */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Bool * ) SAL_THROW( () ); @@ -261,7 +260,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Bool There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type boolean */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( @@ -283,7 +283,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuCharType() SAL_THROW( There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type byte */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int8 * ) SAL_THROW( () ); @@ -293,7 +294,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int8 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type string */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::rtl::OUString * ) SAL_THROW( () ); @@ -303,7 +305,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const ::rtl::OU There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type short */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int16 * ) SAL_THROW( () ); @@ -313,7 +316,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int16 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type unsigned short */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt16 * ) SAL_THROW( () ); @@ -323,7 +327,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt1 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type long */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int32 * ) SAL_THROW( () ); @@ -333,7 +338,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int32 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type unsigned long */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt32 * ) SAL_THROW( () ); @@ -343,7 +349,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt3 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type hyper */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int64 * ) SAL_THROW( () ); @@ -353,7 +360,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_Int64 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type unsigned hyper */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt64 * ) SAL_THROW( () ); @@ -363,7 +371,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const sal_uInt6 There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type float */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const float * ) SAL_THROW( () ); @@ -373,7 +382,8 @@ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const float * ) There are cases (involving templates) where uses of getCppuType are known to not compile. Use cppu::UnoType or cppu::getTypeFavourUnsigned instead. - @param dummy typed pointer for function signature + The dummy parameter is just a typed pointer for function signature. + @return type of IDL type double */ inline const ::com::sun::star::uno::Type & SAL_CALL getCppuType( const double * ) SAL_THROW( () ); |