From a5864e152b5f2a89a4258745d941ae0f67ff7b06 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Wed, 6 Oct 2021 15:21:36 -0500 Subject: [PATCH] Adjust Doxygen annotation comments --- modules/libcom/src/osi/epicsTime.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/libcom/src/osi/epicsTime.h b/modules/libcom/src/osi/epicsTime.h index 05c02cf63..4d7a8572f 100644 --- a/modules/libcom/src/osi/epicsTime.h +++ b/modules/libcom/src/osi/epicsTime.h @@ -184,7 +184,7 @@ LIBCOM_API int epicsStdCall epicsTimeFromTimeval ( /** \name Arithmetic operations * Arithmetic operations on epicsTimeStamp objects and time differences - * which are always expressed as a \c double in seconds. + * which are normally expressed as a \c double in seconds. * @{ */ /** \brief Time difference between \p left and \p right in seconds. */ LIBCOM_API double epicsStdCall epicsTimeDiffInSeconds ( @@ -192,13 +192,13 @@ LIBCOM_API double epicsStdCall epicsTimeDiffInSeconds ( /** \brief Add some number of seconds to \p dest */ LIBCOM_API void epicsStdCall epicsTimeAddSeconds ( epicsTimeStamp * pDest, double secondsToAdd ); /* adds seconds to *pDest */ -/** @} */ - -/** \brief Return difference LHS-RHS as signed integer nanoseconds. +/** \brief Time difference between \p left and \p right, as a signed integer + * number of nanoseconds. * @since UNRELEASED */ -LIBCOM_API -epicsInt64 epicsStdCall epicsTimeDiffInNS (const epicsTimeStamp *pLeft, const epicsTimeStamp *pRight); +LIBCOM_API epicsInt64 epicsStdCall epicsTimeDiffInNS ( + const epicsTimeStamp *pLeft, const epicsTimeStamp *pRight); +/** @} */ /** \name Comparison operators * Comparisons between epicsTimeStamp objects, returning 0=false, 1=true.