/**
* @file FIo.h
- * @brief This is the header file for the Tizen::Io namespace.
+ * @brief This is the header file for the %Io namespace.
*
- * This header file contains the declarations of the Tizen::Io namespace.
+ * This header file contains the declarations of the %Io namespace.
*/
#ifndef _FIO_H_
//
/**
* @file FIoChannelTypes.h
- * @brief This is the header file for the %ChannelType class.
+ * @brief This is the header file for the %ChannelType enumerator.
*
- * This header file contains the enumerator declarations of the %ChannelType class.
+ * This header file contains the declarations of the %ChannelType enumerator.
*/
#ifndef _FIO_CHANNEL_TYPES_H_
#define _FIO_CHANNEL_TYPES_H_
* (the query did not yield any result). @n
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
* @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or
* it is possible if the database file is corrupted.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::String GetColumnName(int columnIndex) const;
* (the query did not yield any result). @n
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
/**
* @file FIoDbTypes.h
- * @brief This is the header file for the %DbTypes class.
+ * @brief This is the header file for the %DbColumnType enumerator.
*
- * This header file contains enum declarations of the @e %DbTypes class.
+ * This header file contains the declarations of the %DbColumnType enumerator.
*/
#ifndef _FIO_DB_TYPES_H_
/**
* @enum DbColumnType
*
- * Defines types of column.
+ * Defines the column types.
*
* @since 2.0
*/
DB_COLUMNTYPE_DOUBLE, /**< The column type is double */
DB_COLUMNTYPE_TEXT, /**< The column type is text */
DB_COLUMNTYPE_BLOB, /**< The column type is blob */
- DB_COLUMNTYPE_NULL, /**< The column type is null */
+ DB_COLUMNTYPE_NULL, /**< The column type is @c null */
DB_COLUMNTYPE_UNDEFINED
};
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The length of the specified path is @c 0 or exceeds
* system limitations. @n
- * - The specified path is invalid.@n
+ * - The specified path is invalid. @n
* - The file handle is invalid (either the file is closed by
* another method, or the memory is corrupted).
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
bool IsReadOnly(void) const;
/**
- * Gets the date and time of the file creation or last modification.
+ * Gets the date and time of the last modification to the file.
*
* @since 2.0
*
- * @return The date and time of the file creation or last modification
- * @remarks If the created file is modified, its date and time is updated.
+ * @return The date and time of the last modification to the file
*/
Tizen::Base::DateTime GetDateTime(void) const;
/**
* @enum FileLockType
*
- * Defines the file lock type
+ * Defines the file lock types.
*
* @since 2.1
*/
enum FileLockType
{
- FILE_LOCK_SHARED, /**< More than one process can hold a shared file lock on a file region.
+ FILE_LOCK_SHARED, /**< More than one process can hold a shared file lock on a file region @n
A shared lock prevents any other process from setting an exclusive lock on the file
- region . */
- FILE_LOCK_EXCLUSIVE /**< Only one process can hold an exclusive lock on a file region.
+ region. */
+ FILE_LOCK_EXCLUSIVE /**< Only one process can hold an exclusive lock on a file region @n
An exclusive lock prevents any other process from setting both shared and exclusive
lock on the file region. */
};
public:
/**
- * This destructor releases the file lock on the current opened file if acquired
+ * This destructor releases the file lock on the current opened file if acquired.
*
* @since 2.1
*/
/**
* Checks whether the file lock is valid. @n
- * The lock is valid unless the associated %File has been closed.
+ * The lock is valid unless the associated file has been closed.
*
* @since 2.1
*
* @interface IChannelRequestEventListener
* @brief <i> [Deprecated] </i> This interface provides event handlers for any request events received through a channel.
*
-* @deprecated This class is deprecated. Instead of using this class, use IMessagePortListener class.
+* @deprecated This interface is deprecated. Instead of using this interface, use the IMessagePortListener interface.
* @since 2.0
*
* The %IChannelRequestEventListener interface provides event handlers to receive channel request event.
* @interface IChannelResponseEventListener
* @brief <i> [Deprecated] </i> This interface provides event handlers for any response events received through a channel.
*
-* @deprecated This class is deprecated. Instead of using this class, use MessagePortManager class.
+* @deprecated This class is deprecated. Instead of using this class, use the MessagePortManager class.
* @since 2.0
*
* The %IChannelResponseEventListener interface provides event handlers for receiving the channel response events.
* - This instance has not been properly constructed. @n
* - The method has tried to fetch the column data of a result set that is not activated
* (the query did not yield any result). @n
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnCount(void) const = 0;
* - The method has tried to fetch the column data of a result set that is not activated
* (the query did not yield any result). @n
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
* @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or
* it is possible if the database file is corrupted.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::String GetColumnName(int columnIndex) const = 0;
* - The method has tried to fetch the column data of a result set that is not activated
* (the query did not yield any result). @n
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
* If the destination column is of type %String, this method returns the @c byte length excluding the @c null terminator character. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
* @param[in] events The file event type @n
* Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
* Tizen::Io::FILE_EVENT_TYPE_ALL is provided for all file event type.
- * @param[in] path The path to the directory or file that event is occurred
- * @param[in] eventId The event id associating related events for single operation such as File::Move, Directory::Rename
+ * @param[in] path The path to the directory or file where the event has occurred
+ * @param[in] eventId The event ID associating related events for single operation such as File::Move(), Directory::Rename()
*/
virtual void OnFileEventOccured(const unsigned long events, const Tizen::Base::String& path, const unsigned int eventId) = 0;
* The recommended message size is under 4KB.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The local message port is null. @n
+ * - The local message port is @c null. @n
* - The message argument is not a map of key (String) and value (String or ByteBuffer) pair.
* @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
* @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
* @param[in] pColumnList A list of column names to query @n
* The type of objects contained in the specified @c pColumnList must be
* Tizen::Base::String class.
- * If it is null, all columns are returned in result set.
+ * If it is @c null, all columns are returned in result set.
* @param[in] pWhere A filter to select desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c pColumnList is empty.
- * - The specified @c pOrder is null and @c pLimit is not null.
- * - The specified @c pGroup is null and @c pHaving is not null.
+ * - The specified @c pOrder is @c null and @c pLimit is not @c null.
+ * - The specified @c pGroup is @c null and @c pHaving is not @c null.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
* @param[in] pWhere A filter to select desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * If it is null, all rows are deleted.
+ * If it is @c null, all rows are deleted.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
projects / platform / framework / native / appfw.git / commitdiff