From fa0592274fbc134bd3b75dec0a8752e74c342c5a Mon Sep 17 00:00:00 2001 From: NEUpanning Date: Fri, 17 May 2024 15:17:31 +0800 Subject: [PATCH] update doc --- velox/type/Timestamp.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/velox/type/Timestamp.h b/velox/type/Timestamp.h index fb94bd7f34709..2e13558c1d3c4 100644 --- a/velox/type/Timestamp.h +++ b/velox/type/Timestamp.h @@ -311,13 +311,13 @@ struct Timestamp { // Same as above, but accepts PrestoDB time zone ID. void toGMT(int16_t tzID); - // Assuming the timestamp represents a GMT time, converts it to the time at - // the same moment at zone. - // If allowOverflow is true, integer overflow is allowed in converting - // timestamp to TimePoint, otherwise we throw. - // Example: Timestamp ts{0, 0}; - // ts.Timezone("America/Los_Angeles"); - // ts.toString() returns December 31, 1969 16:00:00 + /// Assuming the timestamp represents a GMT time, converts it to the time at + /// the same moment at zone. + /// @param allowOverflow If true, integer overflow is allowed when converting + /// timestamp to TimePoint. Otherwise, user exception is thrown for overflow. + /// Example: Timestamp ts{0, 0}; + /// ts.Timezone("America/Los_Angeles"); + /// ts.toString() returns December 31, 1969 16:00:00 void toTimezone(const date::time_zone& zone, bool allowOverflow = false); // Same as above, but accepts PrestoDB time zone ID.