doxygen @ tags replaced to \
This commit is contained in:
@@ -21,7 +21,7 @@
|
||||
|
||||
|
||||
/** \class PIVariant
|
||||
* @brief Variant type
|
||||
* \brief Variant type
|
||||
* \details
|
||||
* \section PIVariant_sec0 Synopsis
|
||||
* This class provides general type that can contains all standard types, some
|
||||
@@ -220,7 +220,7 @@ PIString PIVariant::typeName(PIVariant::Type type) {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as boolean
|
||||
/** \brief Returns variant content as boolean
|
||||
* \details In case of numeric types returns \b true if value != 0. \n
|
||||
* In case of String type returns \a PIString::toBool(). \n
|
||||
* In case of StringList type returns \b false if string list is empty,
|
||||
@@ -251,7 +251,7 @@ bool PIVariant::toBool() const {
|
||||
|
||||
|
||||
|
||||
/** @brief Returns variant content as int
|
||||
/** \brief Returns variant content as int
|
||||
* \details In case of numeric types returns integer value. \n
|
||||
* In case of String type returns \a PIString::toInt(). \n
|
||||
* In case of StringList type returns \b 0 if string list is empty,
|
||||
@@ -283,7 +283,7 @@ int PIVariant::toInt() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as long long
|
||||
/** \brief Returns variant content as long long
|
||||
* \details In case of numeric types returns integer value. \n
|
||||
* In case of String type returns \a PIString::toLLong(). \n
|
||||
* In case of StringList type returns \b 0L if string list is empty,
|
||||
@@ -314,7 +314,7 @@ llong PIVariant::toLLong() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as float
|
||||
/** \brief Returns variant content as float
|
||||
* \details In case of numeric types returns float value. \n
|
||||
* In case of String type returns \a PIString::toFloat(). \n
|
||||
* In case of StringList type returns \b 0.f if string list is empty,
|
||||
@@ -345,7 +345,7 @@ float PIVariant::toFloat() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as double
|
||||
/** \brief Returns variant content as double
|
||||
* \details In case of numeric types returns double value. \n
|
||||
* In case of String type returns \a PIString::toDouble(). \n
|
||||
* In case of StringList type returns \b 0. if string list is empty,
|
||||
@@ -376,7 +376,7 @@ double PIVariant::toDouble() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as long double
|
||||
/** \brief Returns variant content as long double
|
||||
* \details In case of numeric types returns long double value. \n
|
||||
* In case of String type returns \a PIString::toLDouble(). \n
|
||||
* In case of StringList type returns \b 0. if string list is empty,
|
||||
@@ -407,7 +407,7 @@ ldouble PIVariant::toLDouble() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as time
|
||||
/** \brief Returns variant content as time
|
||||
* \details In case of Time type returns time value. \n
|
||||
* In case of DateTime type returns time part of value. \n
|
||||
* In case of other types returns \a PITime(). */
|
||||
@@ -420,7 +420,7 @@ PITime PIVariant::toTime() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as date
|
||||
/** \brief Returns variant content as date
|
||||
* \details In case of Date type returns date value. \n
|
||||
* In case of DateTime type returns date part of value. \n
|
||||
* In case of other types returns \a PIDate(). */
|
||||
@@ -433,7 +433,7 @@ PIDate PIVariant::toDate() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as date and time
|
||||
/** \brief Returns variant content as date and time
|
||||
* \details In case of Time type returns time value with null date. \n
|
||||
* In case of Date type returns date value with null time. \n
|
||||
* In case of DateTime type returns date and time. \n
|
||||
@@ -448,7 +448,7 @@ PIDateTime PIVariant::toDateTime() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as system time
|
||||
/** \brief Returns variant content as system time
|
||||
* \details In case of SystemTime type returns system time. \n
|
||||
* In case of other types returns \a PISystemTime::fromSeconds() from
|
||||
* double value of variant content. */
|
||||
@@ -460,7 +460,7 @@ PISystemTime PIVariant::toSystemTime() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as string
|
||||
/** \brief Returns variant content as string
|
||||
* \details In case of numeric types returns \a PIString::fromNumber(). \n
|
||||
* In case of String type returns string value. \n
|
||||
* In case of StringList type returns joined string ("(" + PIStringList::join("; ") + ")"). \n
|
||||
@@ -501,7 +501,7 @@ PIString PIVariant::toString() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as strings list
|
||||
/** \brief Returns variant content as strings list
|
||||
* \details In case of StringList type returns strings list value. \n
|
||||
* In case of other types returns \a PIStringList with one string value of variant content. */
|
||||
PIStringList PIVariant::toStringList() const {
|
||||
@@ -513,7 +513,7 @@ PIStringList PIVariant::toStringList() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as bit array
|
||||
/** \brief Returns variant content as bit array
|
||||
* \details In case of BitArray type returns bit array value. \n
|
||||
* In case of other types returns \a PIBitArray from \a toLLong() value. */
|
||||
PIBitArray PIVariant::toBitArray() const {
|
||||
@@ -524,7 +524,7 @@ PIBitArray PIVariant::toBitArray() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as byte array
|
||||
/** \brief Returns variant content as byte array
|
||||
* \details In case of ByteArray type returns byte array value. \n
|
||||
* In case of other types returns empty \a PIByteArray. */
|
||||
PIByteArray PIVariant::toByteArray() const {
|
||||
@@ -535,7 +535,7 @@ PIByteArray PIVariant::toByteArray() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as enum
|
||||
/** \brief Returns variant content as enum
|
||||
* \details In case of Enum type returns enum value. \n
|
||||
* In case of String returns Enum with one member. \n
|
||||
* In case of StringList returns Enum with corresponding members. \n
|
||||
@@ -550,7 +550,7 @@ PIVariantTypes::Enum PIVariant::toEnum() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as file
|
||||
/** \brief Returns variant content as file
|
||||
* \details In case of File type returns file value. \n
|
||||
* In case of String returns File with string value path. \n
|
||||
* In case of other types returns empty File. */
|
||||
@@ -563,7 +563,7 @@ PIVariantTypes::File PIVariant::toFile() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as dir
|
||||
/** \brief Returns variant content as dir
|
||||
* \details In case of Dir type returns dir value. \n
|
||||
* In case of String returns Dir with string value path. \n
|
||||
* In case of other types returns empty Dir. */
|
||||
@@ -576,7 +576,7 @@ PIVariantTypes::Dir PIVariant::toDir() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as color
|
||||
/** \brief Returns variant content as color
|
||||
* \details In case of Color type returns color value. \n
|
||||
* In case of int returns color with int value. \n
|
||||
* In case of other types returns empty Color. */
|
||||
@@ -589,7 +589,7 @@ PIVariantTypes::Color PIVariant::toColor() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as IODevice
|
||||
/** \brief Returns variant content as IODevice
|
||||
* \details In case of IODevice type returns IODevice value. \n
|
||||
* In case of other types returns empty IODevice. */
|
||||
PIVariantTypes::IODevice PIVariant::toIODevice() const {
|
||||
@@ -599,7 +599,7 @@ PIVariantTypes::IODevice PIVariant::toIODevice() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as point
|
||||
/** \brief Returns variant content as point
|
||||
* \details In case of PIPointd type returns point value. \n
|
||||
* In case of other types returns empty PIPointd. */
|
||||
PIPointd PIVariant::toPoint() const {
|
||||
@@ -609,7 +609,7 @@ PIPointd PIVariant::toPoint() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as rect
|
||||
/** \brief Returns variant content as rect
|
||||
* \details In case of PIRectd type returns rect value. \n
|
||||
* In case of other types returns empty PIRectd. */
|
||||
PIRectd PIVariant::toRect() const {
|
||||
@@ -619,7 +619,7 @@ PIRectd PIVariant::toRect() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as math vector
|
||||
/** \brief Returns variant content as math vector
|
||||
* \details In case of PIMathVectord type returns rect value. \n
|
||||
* In case of other types returns empty PIMathVectord. */
|
||||
PIMathVectord PIVariant::toMathVector() const {
|
||||
@@ -629,7 +629,7 @@ PIMathVectord PIVariant::toMathVector() const {
|
||||
}
|
||||
|
||||
|
||||
/** @brief Returns variant content as math matrix
|
||||
/** \brief Returns variant content as math matrix
|
||||
* \details In case of PIMathMatrixd type returns rect value. \n
|
||||
* In case of other types returns empty PIMathMatrixd. */
|
||||
PIMathMatrixd PIVariant::toMathMatrix() const {
|
||||
|
||||
Reference in New Issue
Block a user