[3.0] Modify doxygen of Base::Collection
authordahyeong.kim <dahyeong.kim@samsung.com>
Wed, 10 Jul 2013 01:43:35 +0000 (10:43 +0900)
committerdahyeong.kim <dahyeong.kim@samsung.com>
Wed, 10 Jul 2013 01:43:35 +0000 (10:43 +0900)
Change-Id: I6cb88e61654a76f47437321900400ee4aee11fa3
Signed-off-by: dahyeong.kim <dahyeong.kim@samsung.com>
inc/FBaseColIList.h
inc/FBaseColIMap.h
inc/FBaseColIMapEnumerator.h
inc/FBaseColIMultiMap.h
inc/FBaseColMultiHashMap.h
inc/FBaseColQueue.h
inc/FBaseColStack.h

index 1292088..3736489 100644 (file)
@@ -146,7 +146,7 @@ public:
         * @remarks             If the @c index equals the number of elements in the list, the new element
         *                              is added at the end of the list.
         *                      This method performs a shallow copy. It inserts the pointer only; not the element itself.
-        * @see                 Add()
+        * @see                 Add(Object*)
         * @see                 RemoveAt()
         * @endif
         */
@@ -170,7 +170,7 @@ public:
         * @remarks             If the @c index equals the number of elements in the list, the new element
         *                              is added at the end of the list.
         *                      This method performs a shallow copy. It inserts the pointer only; not the element itself.
-        * @see                 Add()
+        * @see                 Add(Object*)
         * @see                 RemoveAt()
         */
        virtual result InsertAt(Object* pObj, int index) = 0;
@@ -315,24 +315,25 @@ public:
         *                                                                      else @c false
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OBJ_NOT_FOUND         The specified @c obj is not found.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             Remove(obj, @b true) internally works as the below code:
+        *                              - Remove(obj, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * Remove(obj);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             Remove(obj, @b false) internally works as the below code:
+        *                              - Remove(obj, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
         * Remove(obj);
         * SetDeleter(deleter);
         * @endcode
-        * @see                 Add()
+        * @see                 Add(Object*)
         * @see                 RemoveAt()
         */
        result Remove(const Object& obj, bool forceDeletion)
@@ -362,7 +363,7 @@ public:
         * @param[in]   obj                     The object to remove
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OBJ_NOT_FOUND         The specified @c obj is not found.
-        * @see                 Add()
+        * @see                 Add(Object*)
         * @see                 RemoveAt()
         */
        virtual result Remove(const Object& obj) = 0;
@@ -379,17 +380,18 @@ public:
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  The specified index is outside the bounds of the data structure, or
         *                                                                              the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             RemoveAt(index, @b true) internally works as the below code:
+        *                              - RemoveAt(index, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * RemoveAt(index);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             RemoveAt(index, @b false) internally works as the below code:
+        *                              - RemoveAt(index, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -444,17 +446,18 @@ public:
         *                                                                              - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
         *                                                                              - The @c count is greater than the number of elements starting from @c startIndex
         *                                                                              or less than @c 0.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             RemoveItems(startIndex, count, @b true) internally works as the below code:
+        *                              - RemoveItems(startIndex, count, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * RemoveItems(startIndex, count);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             RemoveItems(startIndex, count, @b false) internally works as the below code:
+        *                              - RemoveItems(startIndex, count, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -511,17 +514,18 @@ public:
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, or
         *                                                                      the specified @c collection is modified during the operation of this method.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             RemoveItems(collection, @b true) internally works as the below code:
+        *                              - RemoveItems(collection, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * RemoveItems(collection);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             RemoveItems(collection, @b false) internally works as the below code:
+        *                              - RemoveItems(collection, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -574,17 +578,18 @@ public:
         * @return              An error code
         * @param[in]   forceDeletion           Set to @c true to deallocate all the objects, @n
         *                                                      else @c false
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             RemoveAll(@b true) internally works as the below code:
+        *                              - RemoveAll(@b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * RemoveAll();
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             RemoveAll(@b false) internally works as the below code:
+        *                              - RemoveAll(@b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -630,17 +635,18 @@ public:
         * @exception   E_SUCCESS                               The method is successful.
         * @exception   E_OUT_OF_RANGE                  The specified index is outside the bounds of the data structure, or
         *                                                                              the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
-        * @remarks             Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
         *                              If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
-        * @remarks             SetAt(obj, index, @b true) internally works as the below code:
+        *                              - SetAt(obj, index, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * SetAt(const_cast< Object* >(&obj), index);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             SetAt(obj, index, @b false) internally works as the below code:
+        *                              - SetAt(obj, index, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -745,8 +751,9 @@ public:
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, or
         *                                                                      the specified @c collection is modified during the operation of this method.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @remarks             If the given @c collection is empty, this method will return @c true.
+        * @remarks
+        *                              - The specific error code can be accessed using the GetLastResult() method.
+        *                              - If the given @c collection is empty, this method will return @c true.
         * @see                 Contains()
         */
        virtual bool ContainsAll(const ICollection& collection) const = 0;
index 94bd77c..4faa057 100644 (file)
@@ -113,7 +113,7 @@ public:
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
         *                                                                      the comparer has failed to compare the keys.
         * @remarks     This method performs a shallow copy. It adds just the pointer; not the element itself.
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         * @see                 SetValue()
         */
        result AddIfNotExistOrSet(Object* pKey, Object* pValue)
@@ -169,9 +169,10 @@ public:
         *
         * @return              A pointer to a list of all the keys in the map, @n
         *                              else @c null if an exception occurs
-        * @remarks             The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method.
-        * @remarks             The %IList interface stores just the pointers to the elements in the map, not the elements themselves.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method.
+        *                              - The %IList interface stores just the pointers to the elements in the map, not the elements themselves.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         * @see                 GetValuesN()
         */
        virtual IList* GetKeysN(void) const = 0;
@@ -183,8 +184,9 @@ public:
         *
         * @return              A pointer to a list of all the values in the map, @n
         *                              else @c null if an exception occurs
-        * @remarks             The IList stores just the pointers to the elements in the map, not the elements themselves.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - The IList stores just the pointers to the elements in the map, not the elements themselves.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         * @see                 GetKeysN()
         */
        virtual IList* GetValuesN(void) const = 0;
@@ -202,24 +204,25 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The specified @c key is not found in the map.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             Remove(key, @b true) internally works as the below code:
+        *                              - Remove(key, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * Remove(key);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             Remove(key, @b false) internally works as the below code:
+        *                              - Remove(key, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
         * Remove(key);
         * SetDeleter(deleter);
         * @endcode
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         */
        result Remove(const Object& key, bool forceDeletion)
        {
@@ -250,7 +253,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The specified @c key is not found in the map.
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         */
        virtual result Remove(const Object& key) = 0;
 
@@ -262,17 +265,18 @@ public:
         *
         * @param[in]   forceDeletion           Set to @c true to deallocate all the objects, @n
         *                                                              else @c false
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             RemoveAll(@b true) internally works as the below code:
+        *                              - RemoveAll(@b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * RemoveAll();
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             RemoveAll(@b false) internally works as the below code:
+        *                              - RemoveAll(@b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -318,25 +322,25 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The specified @c key is not found in the map.
-        * @remarks     Use the Add() method to add a new key-value pair.
-        * @remarks             Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
-        *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
-        *                              If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
-        * @remarks     SetValue(key, value, @b true) internally works as the below code:
+        * @remarks
+        *                      - Use the Add(Object*, Object*) method to add a new key-value pair.
+        *                      - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        *                      The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
+        *                      If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
+        *                      - SetValue(key, value, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * SetValue(key, const_cast< Object* >(&value));
         * SetDeleter(deleter);
         * @endcode
-        * @remarks     SetValue(key, value, @b false) internally works as the below code:
+        *                      - SetValue(key, value, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
         * SetValue(key, const_cast< Object* >(&value));
         * SetDeleter(deleter);
         * @endcode
-        * @see         Add()
         * @see         GetValue()
         */
        result SetValue(const Object& key, const Object& value, bool forceDeletion = false)
@@ -369,8 +373,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The specified @c key is not found in the map.
-        * @remarks     Use the Add() method to add a new key-value pair.
-        * @see         Add()
+        * @remarks     Use the Add(Object*, Object*) method to add a new key-value pair.
         * @see         GetValue()
         */
        virtual result SetValue(const Object& key, Object* pValue) = 0;
@@ -427,7 +430,7 @@ public:
         *                              else @c false
         * @param[in]   value   The value to locate
         *
-        * @see                 ContainsKey()
+        * @see                 ContainsKey(const Object&)
         */
        virtual bool ContainsValue(const Object& value) const = 0;
 
index 92b9eed..f656fb9 100644 (file)
@@ -74,7 +74,6 @@ public:
         *                                                                      - The enumerator is currently positioned before the first element or after the last element. @n
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                 GetLastResult()
         */
        virtual Object* GetCurrent(void) const = 0;
 
@@ -91,7 +90,6 @@ public:
         *                                                                      - The enumerator is currently positioned before the first element or after the last element. @n
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         GetLastResult()
         */
        virtual Object* GetKey(void) const = 0;
 
@@ -108,7 +106,6 @@ public:
         *                                                                      - The enumerator is currently positioned before the first element or after the last element. @n
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         GetLastResult()
         */
        virtual Object* GetValue(void) const = 0;
 
index 95c5c23..f3b7d61 100644 (file)
@@ -149,8 +149,9 @@ public:
         *
         * @return              A pointer to a list of all unique keys in the map, @n
         *                              else @c null if an exception occurs
-        * @remarks             The %IList stores just the pointers to the elements in the map, not the elements themselves.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - The %IList stores just the pointers to the elements in the map, not the elements themselves.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         * @see                 GetValuesN()
         */
        virtual IList* GetKeysN(void) const = 0;
@@ -162,8 +163,9 @@ public:
         *
         * @return              A pointer to a list of all the values in the map, @n
         *                              else @c null if an exception occurs
-        * @remarks             The IList stores just the pointers to the elements in the map, not the elements themselves.
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - The IList stores just the pointers to the elements in the map, not the elements themselves.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         * @see                 SetValue()
         */
        virtual IList* GetValuesN(void) const = 0;
@@ -181,24 +183,25 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The specified @c key is not found in the map.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             Remove(key, @b true) internally works as the below code:
+        *                              - Remove(key, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * Remove(key);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             Remove(key, @b false) internally works as the below code:
+        *                              - Remove(key, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
         * Remove(key);
         * SetDeleter(deleter);
         * @endcode
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         */
        result Remove(const Object& key, bool forceDeletion)
        {
@@ -229,7 +232,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The specified @c key is not found in the map.
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         */
        virtual result Remove(const Object& key) = 0;
 
@@ -248,24 +251,25 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map.
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             Remove(key, value, @b true) internally works as the below code:
+        *                              - Remove(key, value, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * Remove(key, value);
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             Remove(key, value, @b false) internally works as the below code:
+        *                              - Remove(key, value, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
         * Remove(key, value);
         * SetDeleter(deleter);
         * @endcode
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         */
        result Remove(const Object& key, const Object& value, bool forceDeletion)
        {
@@ -298,7 +302,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map.
-        * @see                 Add()
+        * @see                 Add(Object*, Object*)
         */
        virtual result Remove(const Object& key, const Object& value) = 0;
 
@@ -310,17 +314,18 @@ public:
         *
         * @param[in]   forceDeletion           Set to @c true to deallocate all objects, @n
         *                                                              else @c false
-        * @remarks             Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
         *                              If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
-        * @remarks             RemoveAll(@b true) internally works as the below code:
+        *                              - RemoveAll(@b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * RemoveAll();
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             RemoveAll(@b false) internally works as the below code:
+        *                              - RemoveAll(@b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
@@ -368,25 +373,25 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The key-value pair is not found in the map.
-        * @remarks             Use the Add() method to add a new key-value pair.
-        * @remarks             Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
+        * @remarks
+        *                              - Use the Add(Object*, Object*) method to add a new key-value pair.
+        *                              - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
         *                              The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
         *                              If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
-        * @remarks             SetValue(key, value, newValue, @b true) internally works as the below code:
+        *                              - SetValue(key, value, newValue, @b true) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(SingleObjectDeleter);
         * SetValue(key, value, const_cast< Object* >(&newValue));
         * SetDeleter(deleter);
         * @endcode
-        * @remarks             SetValue(key, value, newValue, @b false) internally works as the below code:
+        *                              - SetValue(key, value, newValue, @b false) internally works as the below code:
         * @code
         * DeleterFunctionType deleter = GetDeleter();
         * SetDeleter(NoOpDeleter);
         * SetValue(key, value, const_cast< Object* >(&newValue));
         * SetDeleter(deleter);
         * @endcode
-        * @see                 Add()
         * @see                 GetValuesN()
         */
        result SetValue(const Object& key, const Object& value, const Object& newValue, bool forceDeletion = false)
@@ -420,8 +425,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @exception   E_OBJ_NOT_FOUND The key-value pair is not found in the map.
-        * @remarks             Use the Add() method to add a new key-value pair.
-        * @see                 Add()
+        * @remarks             Use the Add(Object*, Object*) method to add a new key-value pair.
         * @see                 GetValuesN()
         */
        virtual result SetValue(const Object& key, const Object& value, Object* pNewValue) = 0;
@@ -468,7 +472,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                 ContainsKey()
+        * @see                 ContainsKey(const Object&) const
         * @see                 ContainsValue()
         */
        virtual bool Contains(const Object& key, const Object& value) const = 0;
@@ -491,7 +495,7 @@ public:
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @see                 ContainsValue()
-        * @see                 Contains()
+        * @see                 Contains(const Object&, const Object&)
         * @endif
         */
        result ContainsKey(const Object& key, bool& out) const
@@ -514,7 +518,7 @@ public:
         *                                                              the comparer has failed to compare the keys.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         * @see                 ContainsValue()
-        * @see                 Contains()
+        * @see                 Contains(const Object&, const Object&) const
         */
        virtual bool ContainsKey(const Object& key) const = 0;
 
@@ -527,8 +531,8 @@ public:
         *                              else @c false
         * @param[in]   value   The value to locate
         *
-        * @see                 ContainsKey()
-        * @see                 Contains()
+        * @see                 ContainsKey(const Object&) const
+        * @see                 Contains(const Object&, const Object&) const
         */
        virtual bool ContainsValue(const Object& value) const = 0;
 
@@ -540,9 +544,10 @@ public:
         * @return              An instance of the IMapEnumerator class for the map, @n
         *                              else @c null if an exception occurs
         * @exception   E_SUCCESS               The method is successful.
-        * @remarks             If a key has multiple values, the enumeration proceeds as follows: @n
+        * @remarks
+        *                              - If a key has multiple values, the enumeration proceeds as follows: @n
         *                              {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
-        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         * @see                 IEnumerator
         * @see                 IMapEnumerator
         */
index 248064d..6733d3a 100644 (file)
@@ -238,9 +238,8 @@ public:
         * @return              An enumerator (an instance of the IEnumerator derived class) of this map, @n
         *                              else @c null if some exception occurs
         * @remarks             If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
-        *                      The specific error code can be accessed using the GetLastResult() method.
-        * @see                 IEnumerator()
-        * @see                 IMapEnumerator()
+        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @see                 IMapEnumerator
         */
        virtual IEnumerator* GetEnumeratorN(void) const;
 
@@ -252,9 +251,8 @@ public:
         * @return              An enumerator (an instance of the IMapEnumerator derived class) of this map, @n
         *                              else @c null if some exception occurs
         * @remarks             If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
-        *              The specific error code can be accessed using the GetLastResult() method.
-        * @see                 IEnumerator()
-        * @see                 IMapEnumerator()
+        *                      The specific error code can be accessed using the GetLastResult() method.
+        * @see                 IEnumerator
         */
        virtual IMapEnumerator* GetMapEnumeratorN(void) const;
 
index 8168a1c..b7d5283 100644 (file)
@@ -139,7 +139,7 @@ public:
         * @exception   E_UNDERFLOW     The operation (arithmetic/casting/conversion) has caused an underflow, or
         *                                                      this queue is empty.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         Enqueue()
+        * @see                         Enqueue(Object*)
         */
        virtual Object* Dequeue(void);
 
index ef17a6e..0b63db5 100644 (file)
@@ -168,7 +168,7 @@ public:
         * @exception   E_UNDERFLOW     The operation (arithmetic/casting/conversion) has caused an underflow, or
         *                                                      this stack is empty.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         Push()
+        * @see                         Push(Object*)
         */
        virtual Object* Pop(void);