From: Minkyoung Kang Date: Tue, 6 Aug 2013 06:00:15 +0000 (+0900) Subject: move the sentences in @remarks to other tags X-Git-Tag: accepted/tizen/20131002.165803^2~489^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=34fb00962dde1d65b6e58b22ec5c71395c7d1588;p=platform%2Fframework%2Fnative%2Fuifw.git move the sentences in @remarks to other tags Change-Id: Ie51831af9619e4684c4b007503d3df31ab446851 --- diff --git a/inc/FUiClipboard.h b/inc/FUiClipboard.h index 5ad4d93..8d5d027 100644 --- a/inc/FUiClipboard.h +++ b/inc/FUiClipboard.h @@ -166,10 +166,9 @@ public: * * @since 2.0 * - * @return The pointer to the system clipboard - * @remarks The copy and paste operation is performed through the system - * clipboard that can be obtained through this method. @n - * The method returns @c null if a system error occurs. + * @return The pointer to the system clipboard, @n + * else @c null if a system error has occurred + * @remarks The copy and paste operation is performed through the system clipboard. */ static Clipboard* GetInstance(void); @@ -181,12 +180,10 @@ public: * @return An error code * @param[in] item The item to save in the system clipboard * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is either invalid or not constructed. * @exception E_SYSTEM A system error has occurred. - * @remarks This method returns @c E_INVALID_ARG if the specified item is - * not constructed. @n - * For the text and image data type, the data itself is copied - * by the method and kept by the system clipboard. + * @remarks For the text, image data, and html types, the data itself is copied by the method and kept by the system clipboard. @n + * For the other types, only the file path is copied and kept. */ result CopyItem(const ClipboardItem& item); @@ -194,24 +191,17 @@ public: * Retrieves a collection of items that matches the specified data types from the * system clipboard. * - * @since 2.0 + * @since 2.0 * - * @return The pointer to a Tizen::Base::Collection::IList that contains a collection of ClipboardItem, @n - * else @c null if an error occurs - * @param[in] dataTypes The types of items @n Multiple data types can be - * combined using bitwise OR. + * @return The pointer to a Tizen::Base::Collection::IList that contains a collection of ClipboardItem, @n + * else @c null if an error has occurred @n + * The items are sorted in the reverse order in which they are copied to the system clipboard. So, the first item is the latest one among them. + * @param[in] dataTypes The types of items @n + * Multiple data types of ClipboardDataType can be combined using bitwise OR. * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The item of the specified data types is not found. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * This method returns a pointer to an Tizen::Base::Collection::IList that contains - * a collection of ClipboardItem. The returned pointer to %Tizen::Base::Collection::IList - * and all the elements in %Tizen::Base::Collection::IList must be deleted by applications. @n - * The items in %Tizen::Base::Collection::IList are sorted in the reverse order in which - * they are copied to the system clipboard. So, the first - * item in %Tizen::Base::Collection::IList is the latest one among them. @n - * @c dataType can be a combination of ClipboardDataType. - * @see Tizen::Ui::ClipboardDataType + * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* RetrieveItemsN(unsigned long dataTypes); @@ -221,45 +211,33 @@ public: * @since 2.0 * * @return The pointer to a ClipboardItem instance, @n - * else @c null if an error occurs - * @param[in] dataTypes The types of items @n Multiple data types can be + * else @c null if an error has occurred or there is no matched item in the system clipboard + * @param[in] dataTypes The types of items @n Multiple data types of ClipboardDataType can be * combined using bitwise OR. * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The item of the specified data types is not found. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * This method returns the pointer to a ClipboardItem instance. The - * returned %ClipboardItem must be deleted by applications. @n - * If there is no matched item in the system clipboard, this method - * returns @c null. @n - * @c dataType can be a combination of ClipboardDataType. - * @see Tizen::Ui::ClipboardDataType + * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Ui::ClipboardItem* RetrieveLatestItemN(unsigned long dataTypes); /** - * Shows the clipboard popup with the specified parameters. + * Shows the clipboard popup that is including the current contents of the system clipboard with the specified parameters. * * @since 2.0 * * @return An error code - * @param[in] dataTypes The types of items @n Multiple data types can be - * combined using bitwise OR. + * @param[in] dataTypes The types of items to decide whether the clipboard popup shows image items or not @n + * Multiple data types of ClipboardDataType can be combined using bitwise OR. @n + * If the value contains #CLIPBOARD_DATA_TYPE_IMAGE, all types of items are shown. @n + * If not, text items, html items, video items, and audio items are shown except image items. * @param[in] listener The clipboard popup event listener * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance - * prohibits the execution of the specified - * operation. + * @exception E_INVALID_OPERATION Either the clipboard popup is currently being shown or attempting to show the clipboard popup + * when the application is in the background. * @exception E_SYSTEM A system error has occurred. - * @remarks @c dataTypes can decide whether the clipboard popup shows image items or not. - * If @c dataTypes contains #CLIPBOARD_DATA_TYPE_IMAGE, all types of items are shown. - * If not, text items, html items, video items, and audio items are shown except image items. @n - * This method returns @c E_INVALID_OPERATION if the clipboard popup is currently - * being shown. Furthermore, attempting to show the clipboard popup when the application is - * in the background will return @c E_INVALID_OPERATION. @n - * The clipboard popup shows the current content of the system clipboard. The user - * can clear the system clipboard or choose a clipboard item for the paste operation. - * @see Tizen::Ui::ClipboardDataType + * @remarks The user can operate the system clipboard when the clipboard popup is shown, + * for example, clear the system clipboard or choose a clipboard item for the paste operation. */ static result ShowPopup(unsigned long dataTypes, const IClipboardPopupEventListener& listener); @@ -271,8 +249,8 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. + * - No clipboard popup is currently being shown. * @exception E_SYSTEM A system error has occurred. - * @remarks This method returns @c E_INVALID_OPERATION if no clipboard popup is currently being shown. */ static result HidePopup(void); diff --git a/inc/FUiClipboardItem.h b/inc/FUiClipboardItem.h index 55eb180..941a6f4 100644 --- a/inc/FUiClipboardItem.h +++ b/inc/FUiClipboardItem.h @@ -94,9 +94,8 @@ public: * * @since 2.0 * - * @return The pointer to the data - * @remarks The application needs to type-cast the returned data object - * according to its data type. + * @return The pointer to the data @n + * The application needs to type-cast the returned data object according to its data type. */ Tizen::Base::Object* GetData(void) const;