From bcb06c7739c7a8c021a357a36fdee943f216fd28 Mon Sep 17 00:00:00 2001 From: christian mueller Date: Tue, 13 Mar 2012 15:43:11 +0100 Subject: * enhanced documentation --- include/shared/CAmSerializer.h | 3 ++- include/shared/CAmSocketHandler.h | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) (limited to 'include') diff --git a/include/shared/CAmSerializer.h b/include/shared/CAmSerializer.h index ef6484f..a88c0ad 100644 --- a/include/shared/CAmSerializer.h +++ b/include/shared/CAmSerializer.h @@ -39,10 +39,11 @@ namespace am * The constructor must be called within the main threadcontext, after that using the * overloaded template function call will serialize all calls and call them within the * main thread context.\n + * More details can be found here: \ref util * \warning asynchronous calls may be used in the mainthread context, but if you want to use synchronous calls make sure that you use one * instance of this class per thread otherwise you could be lost in never returning calls.\n * Examples of the usage can be found in IAmCommandReceiverShadow of the ControlPlugin or IAmRoutingReceiverShadow of the - * PluginRoutingInterfaceAsync + * PluginRoutingInterfaceAsync. * */ class CAmSerializer diff --git a/include/shared/CAmSocketHandler.h b/include/shared/CAmSocketHandler.h index ba54b00..9c3b6e7 100644 --- a/include/shared/CAmSocketHandler.h +++ b/include/shared/CAmSocketHandler.h @@ -43,8 +43,9 @@ class IAmShPollDispatch; class IAmShTimerCallBack; /** - * The sockethandler implements a mainloop for the audiomanager. Plugins and different parts of the audiomanager add their filedescriptors to the handler to get called - * on communication of the filedescriptors. + * The am::CAmSocketHandler implements a mainloop for the AudioManager. Plugins and different parts of the AudioManager add their filedescriptors to the handler + * to get called on communication of the filedescriptors.\n + * More information can be found here : \ref mainl */ class CAmSocketHandler { -- cgit v1.2.1