update embedded docs

This commit is contained in:
Axel Kohlmeyer
2023-01-15 10:57:00 -05:00
parent 62f6f91146
commit 015fa4cb0a

View File

@ -28,9 +28,9 @@ namespace platform {
/*! Return the consumed CPU time for the current process in seconds
*
* This is a wrapper around the POSIX function getrusage() and its Windows equivalent.
* It is to be used in a similar fashion than MPI_Wtime(). Its resolution may
* be rather low so it can only be trusted when observing processes consuming at
* seconds or more of CPU time.
* It is to be used in a similar fashion than MPI_Wtime(). Its resolution may be rather
* low so it can only be trusted when observing processes consuming CPU time of at least
* a few seconds.
*
* \return used CPU time in seconds */
@ -38,8 +38,8 @@ namespace platform {
/*! Return the wall clock state for the current process in seconds
*
* This this clock is counting continuous time is initialized during
* Load of the executable/library. Its absolute value must be considered
* This this clock is counting continuous time and is initialized during
* load of the executable/library. Its absolute value must be considered
* arbitrary and thus elapsed wall times are measured in taking differences.
* It is therefore to be used in a similar fashion as MPI_Wtime() but
* has a different offset, usually leading to better resolution.