Fix wrong log value
[platform/core/api/notification.git] / notification-ex / entry_item.h
index e22af08..f6a8ce1 100644 (file)
 namespace notification {
 namespace item {
 
+/**
+ * @brief The class for EntryItem type notification.
+ * @details The class to make the notification with text input.
+ * @since_tizen 5.5
+ */
 class EXPORT_API EntryItem : public AbstractItem {
  public:
+  /**
+   * @brief Constructor
+   * @since_tizen 5.5
+   * @param[in] action The action for EntryItem
+   */
   EntryItem(std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
+
+  /**
+   * @brief Constructor
+   * @since_tizen 5.5
+   * @param[in] id The EntryItem id
+   * @param[in] action The action for EntryItem
+   */
   EntryItem(std::string id,
       std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
+
+  /**
+   * @brief Destructor
+   * @since_tizen 5.5
+   */
   virtual ~EntryItem();
 
-  Bundle Serialize() const override;
-  void Deserialize(Bundle b) override;
-  AbstractItem& FindByID(std::string id) override;
+  /**
+   * @brief Serialize the data of EntryItem.
+   * @since_tizen 5.5
+   * @return Bundle type data
+   */
+  tizen_base::Bundle Serialize() const override;
+
+  /**
+   * @brief Deserialize the serialized data.
+   * @since_tizen 5.5
+   * @param[in] b The serialized Bundle data
+   */
+  void Deserialize(tizen_base::Bundle b) override;
+
+  /**
+   * @brief Checks the item type exist in this notification.
+   * @since_tizen 5.5
+   * @param[in] type notification item type
+   * @return true if the item type exists
+   */
+  bool IsItemTypeExist(int type) override;
+
+  /**
+   * @brief Gets the type of EntryItem.
+   * @since_tizen 5.5
+   * @return AbstractItem::Type::Entry
+   */
   int GetType() const override;
+
+  /**
+   * @brief Gets the text data of EntryItem.
+   * @since_tizen 5.5
+   * @return The text data
+   */;
   std::string GetText() const;
+
+  /**
+   * @brief Sets the text data of EntryItem.
+   * @since_tizen 5.5
+   * @param[in] The text data
+   */
   void SetText(std::string text);
+
+  /**
+   * @brief Gets the limit of text size.
+   * @since_tizen 5.5
+   * @return The limit of text size
+   */
   int GetTextLimit() const;
 
  private: