From 980c1179bbde47bab53410794795781d0e61e82a Mon Sep 17 00:00:00 2001 From: Peter Foley Date: Mon, 18 Mar 2013 21:55:24 -0400 Subject: cleanup doxygen warnings Change-Id: I9181cad5bfa93f9e8b3d944b2b50a3ccc0b42595 --- cppu/inc/com/sun/star/uno/Reference.h | 4 ++-- cppu/inc/typelib/typedescription.h | 4 ++-- cppu/inc/uno/mapping.h | 6 +++--- cppu/inc/uno/threadpool.h | 2 ++ 4 files changed, 9 insertions(+), 7 deletions(-) (limited to 'cppu') diff --git a/cppu/inc/com/sun/star/uno/Reference.h b/cppu/inc/com/sun/star/uno/Reference.h index fe1531b62003..94551a087063 100644 --- a/cppu/inc/com/sun/star/uno/Reference.h +++ b/cppu/inc/com/sun/star/uno/Reference.h @@ -449,7 +449,7 @@ public: inline void set( Any const & rAny, UnoReference_QueryThrow dummy); /** sets the given interface An interface already set will be released. - Throws a RuntimeException if the source interface is . + Throws a RuntimeException if the source interface is @b NULL. @param pInterface an interface pointer @param dummy UNO_SET_THROW to force obvious distinction to other set methods @@ -459,7 +459,7 @@ public: inline void SAL_CALL set( interface_type * pInterface, UnoReference_SetThrow dummy) SAL_THROW( (RuntimeException) ); /** sets the given interface An interface already set will be released. - Throws a RuntimeException if the source interface is . + Throws a RuntimeException if the source interface is @b NULL. @param rRef an interface reference @param dummy UNO_SET_THROW to force obvious distinction to other set methods diff --git a/cppu/inc/typelib/typedescription.h b/cppu/inc/typelib/typedescription.h index bcc9337d6532..89d718f58433 100644 --- a/cppu/inc/typelib/typedescription.h +++ b/cppu/inc/typelib/typedescription.h @@ -422,7 +422,6 @@ typedef struct _typelib_InterfaceAttributeTypeDescription */ typedef struct _typelib_InterfaceTypeDescription -/// @NOHTML { /** inherits all members of typelib_TypeDescription */ @@ -949,7 +948,8 @@ CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_release( /** Retrieves the type description for a given reference. If it is not possible to resolve the reference, null is returned. - @param ppRet inout type description + @param[in,out] ppRet type description + @param[in] pRef type description reference */ CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_getDescription( typelib_TypeDescription ** ppRet, typelib_TypeDescriptionReference * pRef ) diff --git a/cppu/inc/uno/mapping.h b/cppu/inc/uno/mapping.h index 1f3828a597d3..179f41f869c9 100644 --- a/cppu/inc/uno/mapping.h +++ b/cppu/inc/uno/mapping.h @@ -177,9 +177,9 @@ CPPU_DLLPUBLIC void SAL_CALL uno_getMappingByName( /** Function pointer declaration to get a mapping from a loaded bridge. Bridges export a function called uno_ext_getMapping() of this signature. - @param ppMapping [inout] mapping; existing mapping will be released - @pFrom source environment - @pTo destination environment + @param[in,out] ppMapping mapping; existing mapping will be released + @param[in] pFrom source environment + @param[in] pTo destination environment */ typedef void (SAL_CALL * uno_ext_getMappingFunc)( struct _uno_Mapping ** ppMapping, diff --git a/cppu/inc/uno/threadpool.h b/cppu/inc/uno/threadpool.h index 973fa54ceee0..6e880e55b144 100644 --- a/cppu/inc/uno/threadpool.h +++ b/cppu/inc/uno/threadpool.h @@ -108,6 +108,7 @@ uno_threadpool_enter( uno_ThreadPool hPool , void **ppJob ) /** Detaches the current thread from the threadpool. Must be called for every call to uno_threadpool_attach. + @param hPool the handle that was previously created by uno_threadpool_create(). */ CPPU_DLLPUBLIC void SAL_CALL uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C(); @@ -132,6 +133,7 @@ uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C(); If pJob is a reply, there MUST be a thread with the given threadId waiting for this reply. + @param hPool the handle that was previously created by uno_threadpool_create(). @param pThreadId The Id of the thread, that initialized this request. (In general a remote threadid). @param pJob The argument, that doRequest will get or that will be returned by -- cgit