//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
* @file FBaseInt8.h
* @brief This is the header file for the %Int8 class.
*
- * @see Tizen::Base::Number
- *
* This header file contains the declarations of the %Int8 class.
+ *
+ * @see Tizen::Base::Number
*/
#ifndef _FBASE_INT8_H_
#define _FBASE_INT8_H_
#include <FBaseNumber.h>
-
namespace Tizen { namespace Base
{
/**
*
* @since 2.0
*
- * @param[in] value A @c char value
+ * @param[in] value The @c char value
*/
Int8(char value = 0);
-
/**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @param[in] value An instance of %Int8
+ * @param[in] value An instance of %Int8 to copy
*/
Int8(const Int8& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Int8
+ * @param[in] rhs An instance of %Int8 to copy
*/
Int8& operator =(const Int8& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of ch1 is less than the value of ch2
* == 0 if the value of ch1 is equal to the value of ch2
static int Compare(char ch1, char ch2);
/**
- * Compares the value of the current instance with the value of the specified instance of the %Int8 class.
+ * Compares the value of the current instance with the value of the specified instance of %Int8.
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
* > 0 if the value of the current instance is greater than the value of the specified instance
* @endcode
- * @param[in] value An instance of the %Int8 class to compare
+ * @param[in] value An instance of %Int8 to compare
*/
int CompareTo(const Int8& value) const;
*
* @return @c true if the value of the specified instance is equal to the value of the current instance, @n
* else @c false
- * @param[in] obj An instance of Object to compare
+ * @param[in] obj An instance of Tizen::Base::Object to compare
* @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Int8
- * @remarks Two equal instances must return the same hash value. For better performance,
- * the used hash function must generate a random distribution for all inputs. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Int8
+ * @remarks
+ * - Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the specified @c char value
- * @param[in] val A @c char value to get the hash value
+ * @return The integer value that indicates the hash value of the specified @c char value
+ * @param[in] val The @c char value to get the hash value
*/
static int GetHashCode(char val);
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[out] ret The result of the operation
+ * @param[in] s The string that represents the numeric value
+ * @param[out] ret The result of the operation
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
* @remarks This method accepts decimal, hexadecimal, and octal numbers given by the
* - Sign:
* '-'
* @endcode
- * @remarks This method has portability issue. @n
- * When the specified string is nagative number in the ARM architecture, type casting is needed like following code.
+ * @remarks This method has portability issues. @n
+ * When the specified string is a negative number in the ARM architecture, type casting is needed like the following code.
* @code
* char ret;
* Int8::Decode(L"-0X20", ret);
static result Decode(const String& s, char& ret);
/**
- * Parses the @c signed @c char equivalent of the specified string representing a numeric value.
+ * Parses the @c signed @c char equivalent of the specified string that represents a numeric value.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[out] ret The result of the operation
+ * @param[in] s The string that represents a numeric value
+ * @param[out] ret The result of the operation
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a byte that can be parsed.
* @remarks
- * - This method assumes that the string representing the numeric value uses a radix 10.
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method assumes that the string representing the numeric value uses a radix @c 10.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, char& ret);
/**
- * Parses the specified string representing a numeric value and
+ * Parses the specified string that represents a numeric value and
* returns the value as @c signed @c char (as out parameter).
*
* @since 2.0
*
- * @return The @c signed @c char equivalent of the specified string representing the numeric value using the specified index
- * @param[in] s A string representing a numeric value
- * @param[in] radix The radix of the string representing a numeric value @n
- * It must either be 2, 8, 10, or 16.
- * @param[out] ret The result of the operation
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
- * @exception E_OUT_OF_RANGE The specified @c radix is invalid.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @return The @c signed @c char equivalent of the specified string that represents the numeric value using the specified index
+ * @param[in] s The string that represents the numeric value
+ * @param[in] radix The radix of the string that represents the numeric value @n
+ * It must either be 2, 8, 10, or 16.
+ * @param[out] ret The result of the operation
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
+ * @exception E_OUT_OF_RANGE The specified @c radix is invalid.
+ * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int radix, char& ret);
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of %Int8.
+ * Gets the string that represents the value of the current instance of %Int8.
*
* @since 2.0
*
- * @return A string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c signed @c char value using radix @c 10.
+ * Gets the string that represents the specified @c signed @c char value using radix @c 10.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c char value using radix 10
- * @param[in] value A @c char value
+ * @return The string that contains the Unicode representation of the specified @c char value using radix @c 10
+ * @param[in] value The @c char value
*/
static String ToString(char value);
/**
- * A constant holding the maximum value of type @c char. @n
+ * The constant holding the maximum value of type @c char. @n
* A @c short character can hold a value of upto 2^7-1.
*
* @since 2.0
static const char VALUE_MAX = (signed char) 0x7F;
/**
- * A constant holding the minimum value of type @c char. @n
+ * The constant holding the minimum value of type @c char. @n
* A @c short character can hold a value of upto -2^7.
*
* @since 2.0
static const char VALUE_MIN = (signed char) 0x80;
/**
- * A @c signed @c char value of this instance.
+ * The @c signed @c char value of this instance.
*
* @since 2.0
*/
private:
friend class _Int8Impl;
- class _Int8Impl * __pInt8Impl;
+ class _Int8Impl* __pInt8Impl;
}; // Int8
projects / platform / framework / native / appfw.git / blobdiff