contentstorage/caclient/stub/src/caobjectadapter.cpp
changeset 103 b99b84bcd2d1
parent 83 156f692b1687
child 115 3ab5c078b490
--- a/contentstorage/caclient/stub/src/caobjectadapter.cpp	Fri Jun 11 13:58:37 2010 +0300
+++ b/contentstorage/caclient/stub/src/caobjectadapter.cpp	Wed Jun 23 18:33:40 2010 +0300
@@ -24,9 +24,12 @@
 #include "caicondescription.h"
 #include <cadefs.h>
 
-//----------------------------------------------------------------------------
-//
-//----------------------------------------------------------------------------
+/*!
+ * Create an icon.
+ * \param entry a CaEntry instance.
+ * \param size a size of the icon
+ * \retval a HbIcon instance.
+ */
 HbIcon CaObjectAdapter::makeIcon(const CaEntry &entry, const QSize &size)
 {
     HbIcon icon;
@@ -42,27 +45,31 @@
 }
 
 
-//----------------------------------------------------------------------------
-//
-//----------------------------------------------------------------------------
-void CaObjectAdapter::setId(CaEntry &entry,
-                            int id)
+/*!
+ * Set entry id.
+ * \param entry entry.
+ * \param id entry id.
+ */
+void CaObjectAdapter::setId(CaEntry &entry, int id)
 {
     entry.setId(id);
 }
 
-//----------------------------------------------------------------------------
-//
-//----------------------------------------------------------------------------
-void CaObjectAdapter::setId(CaIconDescription &iconDescription,
-                            int id)
+/*!
+ * Set icon description id.
+ * \param iconDescription icon description.
+ * \param id icon description id.
+ */
+void CaObjectAdapter::setId(CaIconDescription &iconDescription, int id)
 {
     iconDescription.setId(id);
 }
 
-//----------------------------------------------------------------------------
-//
-//----------------------------------------------------------------------------
+/**
+ * Convert Symbian error code to error code (used in QT code).
+ * \param internalErrorCode Symbian error code.
+ * \retval converted error code (ErrorCode enum).
+ */
 ErrorCode CaObjectAdapter::convertErrorCode(int internalErrorCode)
 {
     ErrorCode error(NoErrorCode);