From 7841da457942d86a975c614260a7e7812d545a8e Mon Sep 17 00:00:00 2001 From: Reinhard Pfau Date: Sun, 31 May 2009 23:45:59 +0200 Subject: [PATCH] some minor doc updates --- utils/asyncio_time_tools.cpp | 11 ++++++----- utils/asyncio_time_tools.hpp | 10 +++++++--- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/utils/asyncio_time_tools.cpp b/utils/asyncio_time_tools.cpp index 86aae52..2026686 100644 --- a/utils/asyncio_time_tools.cpp +++ b/utils/asyncio_time_tools.cpp @@ -17,13 +17,14 @@ in accordance with section (3) of the GNU General Public License. This exception does not invalidate any other reasons why a work based on this file might be covered by the GNU General Public License. */ -/** +/** * @file * @brief * - * @author Reinhard Pfau \ + * @author Reinhard Pfau \ * - * @copyright © Copyright 2008 Intra2Net AG + * @copyright © Copyright 2008-2009 Intra2Net AG + * @contact Intra2net Opensource team \ */ #include "asyncio_time_tools.hpp" @@ -203,7 +204,7 @@ MilliTime& MilliTime::operator += (const MilliTime& lhs) /** * @brief gets the current time as MilliTime structure. - * @param[out] mt reference to the MilliTime strcucture which is filled with the result. + * @param[out] mt reference to the MilliTime structure which is filled with the result. */ void get_current_real_time(MilliTime& mt) { @@ -215,7 +216,7 @@ void get_current_real_time(MilliTime& mt) /** * @brief gets the current time as MilliTime structure. - * @param[out] mt reference to the MilliTime strcucture which is filled with the result. + * @param[out] mt reference to the MilliTime structure which is filled with the result. */ void get_current_monotonic_time(MilliTime& mt) { diff --git a/utils/asyncio_time_tools.hpp b/utils/asyncio_time_tools.hpp index 69869d0..39a5db8 100644 --- a/utils/asyncio_time_tools.hpp +++ b/utils/asyncio_time_tools.hpp @@ -17,13 +17,14 @@ in accordance with section (3) of the GNU General Public License. This exception does not invalidate any other reasons why a work based on this file might be covered by the GNU General Public License. */ -/** +/** * @file * @brief * - * @author Reinhard Pfau \ + * @author Reinhard Pfau \ * - * @copyright © Copyright 2008 Intra2Net AG + * @copyright © Copyright 2008-2009 Intra2Net AG + * @contact Intra2net Opensource team \ */ #ifndef __ASYNCIO__TIME_TOOLS_HPP__ @@ -36,6 +37,9 @@ namespace Utils /** * @brief structure for storing (a point in time as) seconds and milliseconds. + * + * This structure is used at various places within libasyncio to represent points in + * time or time durations. */ struct MilliTime { -- 1.7.1