//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
#include <FBaseColIEnumerator.h>
#include <FBaseRtMutex.h>
-
#ifdef ICollection
#undef ICollection
#endif
{
/**
- * @interface ICollection
- * @brief This interface represents a collection of objects. @n
- * It defines the size, enumerators, and the synchronization mechanism of a collection.
+ * @interface ICollection
+ * @brief This interface represents a collection of objects. @n
+ * It defines the size, the enumerators, and the synchronization mechanism of a collection.
*
* @since 2.0
*
- * The %ICollection interface represents a collection of objects. It defines the size, enumerators, and the synchronization mechanism of a collection.
+ * The %ICollection interface represents a collection of objects. It defines the size, the enumerators, and the synchronization mechanism of a collection.
*
*/
class _OSP_EXPORT_ ICollection
*
* @since 2.0
*
- * @return An integer value indicating the number of objects currently stored in the collection
+ * @return The integer value that indicates the number of objects currently stored in the collection
*/
virtual int GetCount(void) const = 0;
/**
* Gets the enumerator of the %ICollection derived class,
- * or returns @c null if some exception occurs.
+ * or returns @c null if an exception occurs.
*
* @since 2.0
*
- * @return A pointer to an enumerator interface of the %ICollection derived class, @n
+ * @return A pointer to the enumerator interface of the %ICollection derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Use this method to obtain an enumerator (an instance of the IEnumerator derived class)
+ * @remarks
+ * - Use this method to obtain an enumerator (an instance of the IEnumerator derived class)
* to iterate over a collection (an instance of the %ICollection derived class).
- * @remarks The specific error code can be accessed using GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumerator
+ * - The specific error code can be accessed using GetLastResult() method.
*
*/
virtual IEnumerator* GetEnumeratorN(void) const = 0;