[3.0] Update doxygen tags

[platform/core/uifw/dali-core.git] / dali / public-api / object / property-map.h

diff --git a/dali/public-api/object/property-map.h b/dali/public-api/object/property-map.h
index 15a3291..cd4daf1 100644 (file)
--- a/dali/public-api/object/property-map.h
+++ b/dali/public-api/object/property-map.h
@@ -86,8 +86,8 @@ public:
    *
    * Does not check for duplicates
    * @SINCE_1_0.0
-   * @param key to insert
-   * @param value to insert
+   * @param[in] key to insert
+   * @param[in] value to insert
    */
   void Insert( const char* key, const Value& value );
 
@@ -96,8 +96,8 @@ public:
    *
    * Does not check for duplicates
    * @SINCE_1_0.0
-   * @param key to insert
-   * @param value to insert
+   * @param[in] key to insert
+   * @param[in] value to insert
    */
   void Insert( const std::string& key, const Value& value );
 
@@ -106,8 +106,8 @@ public:
    *
    * Does not check for duplicates
    * @SINCE_1_1.39
-   * @param key to insert
-   * @param value to insert
+   * @param[in] key to insert
+   * @param[in] value to insert
    */
   void Insert( Property::Index key, const Value& value );
 
@@ -117,6 +117,7 @@ public:
    * @brief Retrieve the value of the string-value pair at the specified position.
    *
    * @SINCE_1_0.0
+   * @param[in] position The specified position
    * @return A reference to the value at the specified position.
    *
    * @note Will assert if position >= Count()
@@ -129,11 +130,12 @@ public:
    * @brief Retrieve the key at the specified position.
    *
    * @SINCE_1_0.0
+   * @param[in] position The specified position
    * @return A const reference to the key at the specified position.
    *
    * @note Will assert if position >= Count()
    */
-  const std::string& GetKey( SizeType position ) const;
+  const std::string& GetKey( SizeType position ) const DALI_DEPRECATED_API;
 
   /**
    * DEPRECATED_1_1.39 Position based retrieval is no longer supported after extending the key type to both Index and String.
@@ -141,11 +143,12 @@ public:
    * @brief Retrieve the key & the value at the specified position.
    *
    * @SINCE_1_0.0
+   * @param[in] position The specified position
    * @return A reference to the pair of key and value at the specified position.
    *
-   * @note Will assert if position >= Count()
+   * @note Will assert if position >= Count() or key at position is an index key.
    */
-  StringValuePair& GetPair( SizeType position ) const;
+  StringValuePair& GetPair( SizeType position ) const DALI_DEPRECATED_API;
 
   /**
    * @brief Finds the value for the specified key if it exists.
@@ -178,6 +181,19 @@ public:
   Value* Find( Property::Index key ) const;
 
   /**
+   * @brief Finds the value for the specified keys if either exist.
+   *
+   * Will search for the index key first.
+   *
+   * @SINCE_1_1.45
+   * @param[in]  indexKey   The index key to find.
+   * @param[in]  stringKey  The string key to find.
+   *
+   * @return A const pointer to the value if it exists, NULL otherwise
+   */
+  Value* Find( Property::Index indexKey, const std::string& stringKey ) const;
+
+  /**
    * @brief Finds the value for the specified key if it exists and its type is type
    *
    * @SINCE_1_0.0