From: eh1112.kim Date: Tue, 16 Apr 2013 01:43:37 +0000 (+0900) Subject: Merge LB reviewed doxygen. X-Git-Tag: accepted/tizen_2.1/20130425.034728~7 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d0bd79b1745f46a3ad3300e16e25b731c6b9d6c7;p=framework%2Fosp%2Fmessaging.git Merge LB reviewed doxygen. Change-Id: I819064ab7babef49c59f617931b267f34baf6d7e Signed-off-by: eh1112.kim --- diff --git a/inc/FMsgCbsChannel.h b/inc/FMsgCbsChannel.h index 5ae5a84..fb2ceae 100755 --- a/inc/FMsgCbsChannel.h +++ b/inc/FMsgCbsChannel.h @@ -59,7 +59,7 @@ public: virtual ~CbsChannel(void); /** - * Gets the range of a CBS channel + * Gets the range of a CBS channel. * * @since 2.0 * @@ -111,10 +111,10 @@ public: /** * Deactivates the status of a CBS channel. - * @privlevel platform - * @privilege %http://tizen.org/privilege/cellbroadcast * * @since 2.0 + * @privlevel platform + * @privilege %http://tizen.org/privilege/cellbroadcast * * @return An error code * @exception E_SUCCESS The method is successful. @@ -126,11 +126,11 @@ public: /** * Updates the name of a CBS channel. - * @privlevel platform - * @privilege %http://tizen.org/privilege/cellbroadcast * * @since 2.0 - * + * @privlevel platform + * @privilege %http://tizen.org/privilege/cellbroadcast + * @return An error code * @param[in] name The name of the CBS channel to update * @exception E_SUCCESS The method is successful. diff --git a/inc/FMsgCbsMessage.h b/inc/FMsgCbsMessage.h old mode 100644 new mode 100755 index e616d52..ab01499 --- a/inc/FMsgCbsMessage.h +++ b/inc/FMsgCbsMessage.h @@ -117,7 +117,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * In case of an error, this method returns null. + * In case of an error, this method returns @c null. */ Tizen::Base::ByteBuffer* GetSerialNumberN(void) const; @@ -135,7 +135,6 @@ public: * * @since 2.0 * - * * @return The body of a message */ Tizen::Base::String GetText(void) const; @@ -158,8 +157,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * In case of an error, this method returns null. @n - * The alphabet/coding and the language applied to CBS messages are defined in 3GPP TS 23.038 + * In case of an error, this method returns @c null. @n + * The alphabet/coding and the language applied to CBS messages are defined in 3GPP TS 23.038. */ byte GetDataCodingScheme(void) const; @@ -168,7 +167,7 @@ public: * * @since 2.1 * - * @return The language type of a message + * @return The language type of a message */ Tizen::Base::String GetLanguageType(void) const; diff --git a/inc/FMsgDetailedEmailMessage.h b/inc/FMsgDetailedEmailMessage.h old mode 100644 new mode 100755 index 8d9781f..665e755 --- a/inc/FMsgDetailedEmailMessage.h +++ b/inc/FMsgDetailedEmailMessage.h @@ -440,8 +440,8 @@ namespace Tizen { namespace Messaging * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c type is invalid, or * the specified @c recipients string length is too short (< 5). - * @remarks The values for the various recipients can be a string with multiple email addresses separated by semi-colons(;).@n - * The specified @c type contains RECIPIENT_TYPE_TO, RECIPIENT_TYPE_CC, RECIPIENT_TYPE_BCC. + * @remarks The values for the various recipients can be a string with multiple email addresses separated by semi-colons(;). @n + * The specified @c type contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC. * @see GetAddress() */ result SetAddress(RecipientType type, const Tizen::Base::String& recipients); diff --git a/inc/FMsgEmailManager.h b/inc/FMsgEmailManager.h index 9064425..38e7445 100755 --- a/inc/FMsgEmailManager.h +++ b/inc/FMsgEmailManager.h @@ -48,7 +48,7 @@ namespace Tizen { namespace Messaging * * @code * - // Creates a listener to override the OnEmailMessageSent() function of IEmailListener + // Creates a listener to override the OnEmailMessageSent() method of IEmailListener // in order to be notified of a change in the state of the message being sent. class EmailListener diff --git a/inc/FMsgEmailMessage.h b/inc/FMsgEmailMessage.h old mode 100644 new mode 100755 index c0bd9f1..cf17dea --- a/inc/FMsgEmailMessage.h +++ b/inc/FMsgEmailMessage.h @@ -173,7 +173,8 @@ namespace Tizen { namespace Messaging * @param[in] filePath The path of the file to remove * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND The corresponding format file is not found. - * @see AddAttachment(), GetAttachmentListN() + * @see AddAttachment() + * @see GetAttachmentListN() */ result RemoveAttachment(const Tizen::Base::String& filePath); diff --git a/inc/FMsgEtwsPrimaryNotification.h b/inc/FMsgEtwsPrimaryNotification.h old mode 100644 new mode 100755 index e034d73..f501180 --- a/inc/FMsgEtwsPrimaryNotification.h +++ b/inc/FMsgEtwsPrimaryNotification.h @@ -114,7 +114,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * In case of an error, this method returns null. + * In case of an error, this method returns @c null. */ Tizen::Base::ByteBuffer* GetSerialNumberN(void) const; @@ -145,7 +145,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * In case of an error, this method returns null. + * In case of an error, this method returns @c null. */ Tizen::Base::ByteBuffer* GetWarningSecurityInfoN(void) const; diff --git a/inc/FMsgICbsMessageEventListener.h b/inc/FMsgICbsMessageEventListener.h old mode 100644 new mode 100755 index 690e03c..dc87eeb --- a/inc/FMsgICbsMessageEventListener.h +++ b/inc/FMsgICbsMessageEventListener.h @@ -30,7 +30,7 @@ namespace Tizen { namespace Messaging /** * @interface ICbsMessageEventListener - * @brief This is the listener interface for receiving CBS messages. + * @brief This interface is the listener interface for receiving CBS messages. * * @since 2.0 * diff --git a/inc/FMsgIEmailListener.h b/inc/FMsgIEmailListener.h old mode 100644 new mode 100755 index 790a37b..a749039 --- a/inc/FMsgIEmailListener.h +++ b/inc/FMsgIEmailListener.h @@ -33,7 +33,7 @@ namespace Tizen { namespace Messaging /** * @interface IEmailListener - * @brief This is the listener interface for receiving email sent status. + * @brief This interface is the listener interface for receiving email sent status. * * @since 2.0 * diff --git a/inc/FMsgIEtwsPrimaryNotificationEventListener.h b/inc/FMsgIEtwsPrimaryNotificationEventListener.h old mode 100644 new mode 100755 index 539090a..2ac2a08 --- a/inc/FMsgIEtwsPrimaryNotificationEventListener.h +++ b/inc/FMsgIEtwsPrimaryNotificationEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace Messaging /** * @interface IEtwsPrimaryNotificationEventListener - * @brief This is the listener interface for receiving ETWS primary notification. + * @brief This interface is the listener interface for receiving ETWS primary notification. * * @since 2.0 * diff --git a/inc/FMsgIMmsListener.h b/inc/FMsgIMmsListener.h old mode 100644 new mode 100755 index ed6428e..85e3f48 --- a/inc/FMsgIMmsListener.h +++ b/inc/FMsgIMmsListener.h @@ -34,7 +34,7 @@ namespace Tizen { namespace Messaging /** * @interface IMmsListener - * @brief This is the listener interface for receiving MMS sent status. + * @brief This interface is the listener interface for receiving MMS sent status. * * @since 2.0 * diff --git a/inc/FMsgIPushEventListener.h b/inc/FMsgIPushEventListener.h index e3846ff..931e8c8 100755 --- a/inc/FMsgIPushEventListener.h +++ b/inc/FMsgIPushEventListener.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Messaging { /** * @interface IPushEventListener -* @brief This is the listener interface for receiving push messages. +* @brief This interface is the listener interface for receiving push messages. * * @since 2.0 * diff --git a/inc/FMsgIPushManagerListener.h b/inc/FMsgIPushManagerListener.h index 14ec1a0..97a6eb0 100755 --- a/inc/FMsgIPushManagerListener.h +++ b/inc/FMsgIPushManagerListener.h @@ -30,7 +30,7 @@ namespace Tizen { namespace Messaging { /** * @interface IPushManagerListener -* @brief This listener interface receives the registration result. +* @brief This interface is the listener interface that receives the registration result. * * @since 2.0 * @@ -94,7 +94,7 @@ public: * @param[in] reqId The request ID * @param[in] registrationId The registration ID of the recipient * @param[in] r The result of the request, @n - * Exception code may be given through this parameter. + * The following exceptions may be given through this parameter. * @param[in] errorCode The error code from the server * @param[in] errorMsg The error message from the server * @exception E_SUCCESS The method is successful. diff --git a/inc/FMsgISmsEventListener.h b/inc/FMsgISmsEventListener.h old mode 100644 new mode 100755 index 7acb3ff..4e22dc1 --- a/inc/FMsgISmsEventListener.h +++ b/inc/FMsgISmsEventListener.h @@ -17,6 +17,7 @@ /** * @file FMsgISmsEventListener.h * @brief This is the header file for the %ISmsEventListener interface. + * * This header file contains the declarations of the %ISmsEventListener interface. */ @@ -33,7 +34,7 @@ namespace Tizen { namespace Messaging /** * @interface ISmsEventListener - * @brief This is the listener interface for receiving SMS messages. + * @brief This interface is the listener interface for receiving SMS messages. * * @since 2.0 * diff --git a/inc/FMsgISmsListener.h b/inc/FMsgISmsListener.h old mode 100644 new mode 100755 index acbfb09..abea341 --- a/inc/FMsgISmsListener.h +++ b/inc/FMsgISmsListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace Messaging { /** * @interface ISmsListener - * @brief This is the listener interface for receiving SMS sent status. + * @brief This interface is the listener interface for receiving SMS sent status. * * @since 2.0 * diff --git a/inc/FMsgISmsMessageEventListener.h b/inc/FMsgISmsMessageEventListener.h old mode 100644 new mode 100755 index abfbed8..a18fdd3 --- a/inc/FMsgISmsMessageEventListener.h +++ b/inc/FMsgISmsMessageEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace Messaging /** * @interface ISmsMessageEventListener - * @brief This is the listener interface for receiving SMS messages. + * @brief This interface is the listener interface for receiving SMS messages. * * @since 2.0 * diff --git a/inc/FMsgIWapPushEventListener.h b/inc/FMsgIWapPushEventListener.h old mode 100644 new mode 100755 index 4dbab0d..606da95 --- a/inc/FMsgIWapPushEventListener.h +++ b/inc/FMsgIWapPushEventListener.h @@ -18,7 +18,7 @@ * @file FMsgIWapPushEventListener.h * @brief This is the header file for the %IWapPushEventListener interface. * -* This header file contains the declaration of the %IWapPushEventListener interface. +* This header file contains the declarations of the %IWapPushEventListener interface. */ #ifndef _FMSG_IWAP_PUSH_EVENT_LISTENER_H_ @@ -31,7 +31,7 @@ namespace Tizen { namespace Messaging { /** * @interface IWapPushEventListener -* @brief This is the listener interface for receiving WAP Push messages. +* @brief This interface is the listener interface for receiving WAP Push messages. * * @since 2.0 * diff --git a/inc/FMsgMmsManager.h b/inc/FMsgMmsManager.h index 7f70490..749f572 100755 --- a/inc/FMsgMmsManager.h +++ b/inc/FMsgMmsManager.h @@ -51,7 +51,7 @@ namespace Tizen { namespace Messaging * * @code * - // Creates a listener to override the OnMmsMessageSent() function of IMmsListener + // Creates a listener to override the OnMmsMessageSent() method of IMmsListener // in order to be notified of a change in the state of the message being sent. class MmsListener @@ -134,6 +134,7 @@ namespace Tizen { namespace Messaging * Initializes this instance of %MmsManager with the specified parameter. * * @since 2.0 + * * @feature %http://tizen.org/feature/network.telephony.mms * @return An error code * @param[in] listener The listener to receive a send result asynchronously diff --git a/inc/FMsgMmsMessage.h b/inc/FMsgMmsMessage.h old mode 100644 new mode 100755 index 8993225..df11c9c --- a/inc/FMsgMmsMessage.h +++ b/inc/FMsgMmsMessage.h @@ -154,7 +154,7 @@ namespace Tizen { namespace Messaging * - The specified file format is already attached. @n * - The specified @c format is invalid. @n * - The specified file contains invalid or the media is not supported. @n - * - The specified file format cannot be attached.@n + * - The specified file format cannot be attached. @n * (An MMS attachment may contain either an image, audio, video, vCard, or a vCalendar file or a combination of an image, audio, vCard, and vCalendar file. @n * MMS attachments cannot contain a video file in combination with an image or audio file.) * @exception E_MAX_EXCEEDED The size of the file exceeds the maximum limit (Maximum 295KB). @n diff --git a/inc/FMsgPushManager.h b/inc/FMsgPushManager.h index fc4ba4c..e515c95 100755 --- a/inc/FMsgPushManager.h +++ b/inc/FMsgPushManager.h @@ -198,7 +198,7 @@ public: /** * Registers the push messaging service for the current application. @n - * This method is asynchronous. + * The %RegisterPushService() method is asynchronous. * * @since 2.0 * @privlevel public @@ -219,7 +219,7 @@ public: /** * Unregisters the push messaging service for the current application. @n - * This method is asynchronous. + * The %UnregisterPushService() method is asynchronous. * * @since 2.0 * @privlevel public @@ -252,7 +252,7 @@ public: /** * Gets the unread push messages. @n - * If an application receives unread messages with this method, the messages are removed from the system. + * If an application receives unread messages with the %GetUnreadMessagesN() method, the messages are removed from the system. * * @since 2.0 * @privlevel public @@ -272,7 +272,7 @@ public: * as a launch argument. * The launch arguments are the input parameters for * Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceivedN(). - * This function returns all the unread messages including the message + * This method returns all the unread messages including the message * delivered as a launch argument. * @see Tizen::App::IAppControlProviderEventListener */ @@ -280,12 +280,12 @@ public: /** * Sends the push message to a single recipient. @n - * This method is asynchronous. + * The %SendPushMessage() method is asynchronous. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/push and %http://tizen.org/privilege/http @n - * Both privileges are required + * Both privileges are required. * * @pre In order to use the push messaging service, see Push Messaging Guide. * @@ -307,12 +307,12 @@ public: /** * Sends the push message to multiple recipients. @n - * This method is asynchronous. + * The %SendPushMessage() method is asynchronous. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/push and %http://tizen.org/privilege/http @n - * Both privileges are required + * Both privileges are required. * * @pre In order to use the push messaging service, see Push Messaging Guide. * diff --git a/inc/FMsgPushMessage.h b/inc/FMsgPushMessage.h old mode 100644 new mode 100755 index e5a1c83..1747918 --- a/inc/FMsgPushMessage.h +++ b/inc/FMsgPushMessage.h @@ -76,7 +76,7 @@ public: * Gets the body of the message. * * @brief [Deprecated] - * @deprecated This method is deprecated. Instead of using this method, use Tizen::Shell::NotificationRequest::GetAppMessage() method. + * @deprecated This method is deprecated. Instead of using this method, use the Tizen::Shell::NotificationRequest::GetAppMessage() method. * * @since 2.0 * @@ -168,7 +168,7 @@ public: * * @since 2.0 * - * @return The current instance's hash value + * @return The hash value of the current instance */ virtual int GetHashCode(void) const; diff --git a/inc/FMsgRecipientList.h b/inc/FMsgRecipientList.h old mode 100644 new mode 100755 index 8fb18a3..03d625f --- a/inc/FMsgRecipientList.h +++ b/inc/FMsgRecipientList.h @@ -145,7 +145,7 @@ namespace Tizen { namespace Messaging * @exception E_OBJ_ALREADY_EXIST The specified @c recipient is already added. * @exception E_INVALID_ARG The specified @c recipient string length is too short (< 3) or too long (> 320), or * the specified @c type is invalid. - * @remarks The limit of the number of recipients is not checked in this method. This is done in the Send() method of each manager class (SmsManager, MmsManager, and EmailManager). @n + * @remarks The limit of the number of recipients is not checked in this method. This is done in the SmsManager::Send(), MmsManager::Send(), and EmailManager::Send() methods. @n * The minimum length of a recipient is @c 3 for a phone number and @c 5 for an email address. @n * The maximum length of a recipient is @c 41 for a phone number and @c 320 for an email address. * @see Set() diff --git a/inc/FMsgSmsManager.h b/inc/FMsgSmsManager.h index f5af2f1..f7af1ff 100755 --- a/inc/FMsgSmsManager.h +++ b/inc/FMsgSmsManager.h @@ -55,7 +55,7 @@ namespace Tizen { namespace Messaging * * @code * - // Creates a listener to override the OnSmsMessageSent() function of ISmsListener + // Creates a listener to override the OnSmsMessageSent() method of ISmsListener // in order to be notified of a change in the state of the message being sent. class SmsListener @@ -137,6 +137,7 @@ namespace Tizen { namespace Messaging * Initializes this instance of %SmsManager with the specified parameter. * * @since 2.0 + * * @feature %http://tizen.org/feature/network.telephony * @return An error code * @param[in] listener The listener to receive a send result asynchronously @@ -153,7 +154,6 @@ namespace Tizen { namespace Messaging * Adds the event listener for receiving SMS messages. * * @since 2.0 - * * @privlevel partner * @privilege %http://tizen.org/privilege/smstrigger * @@ -177,7 +177,6 @@ namespace Tizen { namespace Messaging * Removes the event listener for receiving SMS messages. * * @since 2.0 - * * @privlevel partner * @privilege %http://tizen.org/privilege/smstrigger * @@ -200,7 +199,6 @@ namespace Tizen { namespace Messaging * Adds the event listener for receiving SMS messages. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -221,7 +219,6 @@ namespace Tizen { namespace Messaging * Removes the event listener for receiving SMS messages. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -243,7 +240,6 @@ namespace Tizen { namespace Messaging * Sends the SMS message. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.write * @@ -272,7 +268,6 @@ namespace Tizen { namespace Messaging * Gets the total number of SMS messages in the specified message box. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -293,7 +288,6 @@ namespace Tizen { namespace Messaging * Searches the SMS messages by keyword and|or sender address in the Inbox. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -330,7 +324,6 @@ namespace Tizen { namespace Messaging * Searches the SMS messages by keyword in the specified message box. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -357,7 +350,8 @@ namespace Tizen { namespace Messaging * The SMS messages in the searched result contain only @c 160 bytes for the body text. @n * To check whether there is additional text, use the SmsMessage::HasMoreText() method. @n * To get the full body text, use the GetFullText() method with its message ID. - * @see SmsMessage, GetFullText() + * @see SmsMessage + * @see GetFullText() */ Tizen::Base::Collection::IList* SearchMessageBoxN(SmsMessageBoxType type, const Tizen::Base::String* pKeyword, int startIndex, int count, int& totalResultCount) const; @@ -365,7 +359,6 @@ namespace Tizen { namespace Messaging * Gets the full text of the SMS message in the message box using the message ID. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -388,9 +381,9 @@ namespace Tizen { namespace Messaging * Sets the event listener for receiving CB messages. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return An error code * @param[in] pListener The listener to receive CB messages @@ -409,9 +402,9 @@ namespace Tizen { namespace Messaging * Sets the event listener for receiving ETWS primary notification. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return An error code * @param[in] pListener The listener to receive ETWS primary notification @@ -427,12 +420,12 @@ namespace Tizen { namespace Messaging result SetEtwsPrimaryNotificationEventListener(IEtwsPrimaryNotificationEventListener* pListener); /** - * Enables or disables the save option for CBS message to the CbsBox + * Enables or disables the save option for CBS message to the CbsBox. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return An error code * @param[in] enable Set to @c true to save the message in the CbsBox, @n @@ -451,7 +444,6 @@ namespace Tizen { namespace Messaging * Checks whether the CB service is enabled. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast * @@ -465,9 +457,9 @@ namespace Tizen { namespace Messaging * Enables or disables the CB service. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return An error code * @param[in] enable Set to @c true to enable the CB service, @n @@ -487,9 +479,9 @@ namespace Tizen { namespace Messaging * Adds a CBS channel with specified parameters. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return An error code * @param[in] from The starting index of the message ID of the channel @@ -520,9 +512,9 @@ namespace Tizen { namespace Messaging * Removes a CBS channel. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return An error code * @param[in] from The starting index of the message ID of the channel @@ -549,9 +541,9 @@ namespace Tizen { namespace Messaging * Gets a CBS channel with specified range. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast + * * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @return A pointer to the CBS channel with specific range. * @param[in] from The starting index of the message ID of the channel @@ -571,7 +563,7 @@ namespace Tizen { namespace Messaging * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). * - The specific error code can be accessed using the GetLastResult() method. * @see AddCbsChannel() - * @see RemoveCbsChannel() + * @see RemoveCbsChannel() */ CbsChannel* GetCbsChannelN(int from, int to) const; @@ -579,10 +571,11 @@ namespace Tizen { namespace Messaging * Gets the CBS channel list. * * @since 2.0 - * @feature %http://tizen.org/feature/network.telephony.sms.cbs * @privlevel platform * @privilege %http://tizen.org/privilege/cellbroadcast * + * @feature %http://tizen.org/feature/network.telephony.sms.cbs + * * @return A pointer to the list of CBS channel * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. diff --git a/inc/FMsgSmsMessage.h b/inc/FMsgSmsMessage.h index c83594d..229ae62 100755 --- a/inc/FMsgSmsMessage.h +++ b/inc/FMsgSmsMessage.h @@ -145,7 +145,6 @@ namespace Tizen { namespace Messaging * Gets the sender address of the SMS message. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -163,7 +162,6 @@ namespace Tizen { namespace Messaging * Gets the received time of the SMS message. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -182,7 +180,6 @@ namespace Tizen { namespace Messaging * Gets the unique ID of the SMS message. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -201,7 +198,6 @@ namespace Tizen { namespace Messaging * Gets the sent time of the SMS message. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -220,7 +216,6 @@ namespace Tizen { namespace Messaging * Gets the type of the SMS message box. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -239,7 +234,6 @@ namespace Tizen { namespace Messaging * Gets the list of the recipients. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) @@ -257,7 +251,6 @@ namespace Tizen { namespace Messaging * Checks whether the SMS message contains more than @c 160 bytes for the body text. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/messaging.read * (%http://tizen.org/privilege/messaging.sms is deprecated.) diff --git a/inc/FMsgTypes.h b/inc/FMsgTypes.h index b09f527..f2c7ce0 100755 --- a/inc/FMsgTypes.h +++ b/inc/FMsgTypes.h @@ -16,9 +16,9 @@ // /** * @file FMsgTypes.h - * @brief This is the header file for the %Messaging class. + * @brief This is the header file for the enumerations of the Messaging namespace. * - * This header file contains the type declarations for the %Messaging namespace. + * This header file contains the type declarations of the Messaging namespace. */ #ifndef _FMSG_TYPES_H_ @@ -29,7 +29,7 @@ namespace Tizen { namespace Messaging /** * @enum RecipientType * - * Defines the recipient type for a Short Message Service(SMS), Multimedia %Messaging Service(MMS) and email messages. + * Defines the recipient type for a Short Message Service(SMS), Multimedia %Messaging Service(MMS), and email messages. * * @since 2.0 */ diff --git a/inc/FMsgWapPushManager.h b/inc/FMsgWapPushManager.h old mode 100644 new mode 100755 index 870b8fa..c56344c --- a/inc/FMsgWapPushManager.h +++ b/inc/FMsgWapPushManager.h @@ -42,6 +42,8 @@ class _WapPushManagerImpl; * @since 2.0 * * @final This class is not intended for extension. +* +* The %WapPushManager class provides methods to use the WAP Push messaging service. */ class _OSP_EXPORT_ WapPushManager : public Tizen::Base::Object @@ -66,9 +68,9 @@ public: * Adds the event listener for receiving WAP Push messages for a specific WAP Push application ID. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/wappush + * * @feature %http://tizen.org/feature/network.telephony * @return An error code * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP Push application ID @@ -93,9 +95,9 @@ public: * ID. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/wappush + * * @feature %http://tizen.org/feature/network.telephony * @return An error code * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP Push @@ -120,13 +122,13 @@ public: * Registers a condition to receive WAP Push message. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/wappush + * * @feature %http://tizen.org/feature/network.telephony * @return An error code - * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID. - * @param[in] contentType The MIME content type of the content. + * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID + * @param[in] contentType The MIME content type of the content * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c contentType or @c wapApplicationId is invalid. * @exception E_ILLEGAL_ACCESS The application does not have the permission to register the conditions. @@ -145,13 +147,13 @@ public: * Unregisters a condition to receive WAP push message. * * @since 2.0 - * * @privlevel platform * @privilege %http://tizen.org/privilege/wappush + * * @feature %http://tizen.org/feature/network.telephony * @return An error code - * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID. - * @param[in] contentType The MIME content type of the content. + * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID + * @param[in] contentType The MIME content type of the content * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c contentType or @c wapApplicationId is invalid. * @exception E_ILLEGAL_ACCESS The application does not have the permission to unregister the conditions. diff --git a/inc/FMsgWapPushMessage.h b/inc/FMsgWapPushMessage.h old mode 100644 new mode 100755 index 4d7d1ca..bd6e291 --- a/inc/FMsgWapPushMessage.h +++ b/inc/FMsgWapPushMessage.h @@ -77,7 +77,7 @@ public: * * @return The body of a message * @remarks The message body can be any MIME content-type. @n - * In case of error, this method returns null. @n + * In case of error, this method returns @c null. @n * The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* GetBodyN(void) const; @@ -112,7 +112,6 @@ public: * else @c null in case of an error * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * * @remarks The specific error code can be accessed using the GetLastResult() method. */ WapPushMessage* CloneN(void) const;