doc ru

libs/main/core/pitime.h

@@ -1,5 +1,8 @@
 /*! \file pitime.h
- * \brief Time structs
+ * \ingroup Core
+ * \~\brief
+ * \~english Time structs and methods
+ * \~russian Типы и методы времени
 */
 /*
 	PIP - Platform Independent Primitives
@@ -30,23 +33,28 @@
 #  include <time.h>
 #endif
 
-/*! \brief Precise sleep for "usecs" microseconds
- * \details This function consider \c "usleep" offset
- * on QNX/Linux/Mac, which is calculated with
- * \a pip_sys_test program. If there is correct
- * offset value in system config, this function
- * wait \b exactly "usecs" microseconds. */
+//! \~english Precise sleep for "usecs" microseconds
+//! \~russian Точно ожидает "usecs" микросекунд
 PIP_EXPORT void piUSleep(int usecs); // on !Windows consider constant "usleep" offset
 
-/*! \brief Precise sleep for "msecs" milliseconds
- * \details This function exec \a piUSleep (msecs * 1000). */
+//! ~\brief
+//! \~english Precise sleep for "msecs" milliseconds
+//! \~russian Точно ожидает "msecs" миллисекунд
+//! ~\details
+//! \~english This function exec \a piUSleep (msecs * 1000)
+//! \~russian Этот метод вызывает \a piUSleep (msecs * 1000)
 inline void piMSleep(double msecs) {piUSleep(int(msecs * 1000.));} // on !Windows consider constant "usleep" offset
 
-/*! \brief Precise sleep for "secs" seconds
- * \details This function exec \a piUSleep (msecs * 1000000). */
+//! ~\brief
+//! \~english Precise sleep for "secs" seconds
+//! \~russian Точно ожидает "secs" секунд
+//! ~\details
+//! \~english This function exec \a piUSleep (msecs * 1000000)
+//! \~russianЭтот метод вызывает \a piUSleep (msecs * 1000000)
 inline void piSleep(double secs) {piUSleep(int(secs * 1000000.));} // on !Windows consider constant "usleep" offset
 
-//! Shortest available on current system sleep
+//! \~english Shortest available on current system sleep
+//! \~russian Наименее возможное для данной системы по длительности ожидание
 inline void piMinSleep() {piMSleep(PIP_MIN_MSLEEP);}