From 1a96dc0cb90f4861f27b4a4773320baebf84b6c5 Mon Sep 17 00:00:00 2001 From: peri4 Date: Wed, 5 Jul 2023 20:53:36 +0300 Subject: [PATCH] PITimeMeasurer doc ru --- libs/main/types/pisystemtime.h | 66 +++++++++++++++++++++++++--------- 1 file changed, 49 insertions(+), 17 deletions(-) diff --git a/libs/main/types/pisystemtime.h b/libs/main/types/pisystemtime.h index d979453e..ffc5993d 100644 --- a/libs/main/types/pisystemtime.h +++ b/libs/main/types/pisystemtime.h @@ -278,27 +278,47 @@ class PIP_EXPORT PITimeMeasurer { public: PITimeMeasurer(); - /** \brief Set internal time mark to current system time - * \details This function used for set start time mark. Later - * you can find out elapsed time from this time mark to any - * moment of time with \a elapsed_s(), \a elapsed_m(), - * \a elapsed_u() or \a elapsed_n() functions. - * \sa \a elapsed_s(), \a elapsed_m(), \a elapsed_u(), \a elapsed_n() */ + //! \~\brief + //! \~english Set time mark to current system time. + //! \~russian Устанавливает отметку времени на текущее время. + //! \~\details + //! \~english + //! This function used for set start time mark. Later + //! you can find out elapsed time from this time mark to any + //! moment of time with \a elapsed(), \a elapsed_s(), + //! \a elapsed_m(), \a elapsed_u(), \a elapsed_n(). + //! \~russian + //! Этот метод используется для установки начальной отметки времени. + //! Далее можно узнать прошедшее от этой метки время с помощью методов + //! \a elapsed(), \a elapsed_s(), \a elapsed_m(), + //! \a elapsed_u(), \a elapsed_n(). + //! \~\a elapsed_u() or \a elapsed_n() functions. + //! \~\sa \a elapsed(), \a elapsed_s(), \a elapsed_m(), \a elapsed_u(), \a elapsed_n() */ void reset() { t_st = PISystemTime::current(true); } - //! \brief Returns nanoseconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~\brief + //! \~english Returns nanoseconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~russian Возвращает в наносекундах время, прошедшее с последнего вызова \a reset(), либо создания измерителя. double elapsed_n() const; - //! \brief Returns microseconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~\brief + //! \~english Returns microseconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~russian Возвращает в микросекундах время, прошедшее с последнего вызова \a reset(), либо создания измерителя. double elapsed_u() const; - //! \brief Returns milliseconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~\brief + //! \~english Returns milliseconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~russian Возвращает в милисекундах время, прошедшее с последнего вызова \a reset(), либо создания измерителя. double elapsed_m() const; - //! \brief Returns seconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~\brief + //! \~english Returns seconds elapsed from last \a reset() execution or from timer measurer creation. + //! \~russian Возвращает в секундах время, прошедшее с последнего вызова \a reset(), либо создания измерителя. double elapsed_s() const; - //! \brief Returns PISystemTime elapsed from last \a reset() execution or from timer measurer creation. + //! \~\brief + //! \~english Returns PISystemTime elapsed from last \a reset() execution or from timer measurer creation. + //! \~russian Возвращает в PISystemTime время, прошедшее с последнего вызова \a reset(), либо создания измерителя. PISystemTime elapsed() const; double reset_time_n() const { return t_st.toNanoseconds(); } @@ -306,22 +326,34 @@ public: double reset_time_m() const { return t_st.toMilliseconds(); } double reset_time_s() const { return t_st.toSeconds(); } - //! \brief Returns time mark of last \a reset() execution or timer measurer creation. + //! \~\brief + //! \~english Returns time mark of last \a reset() execution or timer measurer creation. + //! \~russian Возвращает отметку времени последнего вызова \a reset(), либо создания измерителя. PISystemTime reset_time() { return t_st; } - //! \brief Returns nanoseconds representation of current system time. + //! \~\brief + //! \~english Returns nanoseconds representation of current system time. + //! \~russian Возвращает в наносекундах системное время. static double elapsed_system_n() { return PISystemTime::current(true).toNanoseconds(); } - //! \brief Returns microseconds representation of current system time. + //! \~\brief + //! \~english Returns microseconds representation of current system time. + //! \~russian Возвращает в микросекундах системное время. static double elapsed_system_u() { return PISystemTime::current(true).toMicroseconds(); } - //! \brief Returns milliseconds representation of current system time. + //! \~\brief + //! \~english Returns milliseconds representation of current system time. + //! \~russian Возвращает в милисекундах системное время. static double elapsed_system_m() { return PISystemTime::current(true).toMilliseconds(); } - //! \brief Returns seconds representation of current system time. + //! \~\brief + //! \~english Returns seconds representation of current system time. + //! \~russian Возвращает в секундах системное время. static double elapsed_system_s() { return PISystemTime::current(true).toSeconds(); } - //! \brief Returns time mark of current system time. + //! \~\brief + //! \~english Returns time mark of current system time. + //! \~russian Возвращает системное время. static PISystemTime elapsed_system() { return PISystemTime::current(true); } private: