diff options
Diffstat (limited to '')
-rw-r--r-- | cpukit/include/rtems/rtems/clockimpl.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/cpukit/include/rtems/rtems/clockimpl.h b/cpukit/include/rtems/rtems/clockimpl.h index c13c158410..8ec4f0f6e3 100644 --- a/cpukit/include/rtems/rtems/clockimpl.h +++ b/cpukit/include/rtems/rtems/clockimpl.h @@ -37,16 +37,16 @@ extern "C" { /** * @brief TOD Validate * - * This support function returns true if @a the_tod contains - * a valid time of day, and false otherwise. + * This support function tests whether @a the_tod references + * a valid time of day. * - * @param[in] the_tod is the TOD structure to validate + * @param the_tod A reference to the time of day structure to validate. * - * @retval This method returns true if the TOD is valid and false otherwise. - * - * @note This routine only works for leap-years through 2099. + * @retval RTEMS_SUCCESSFUL @a the_tod references a valid time of day. + * @retval RTEMS_INVALID_CLOCK @a the_tod references an invalid time of day. + * @retval RTEMS_INVALID_ADDRESS @a the_tod reference is @c NULL. */ -bool _TOD_Validate( +rtems_status_code _TOD_Validate( const rtems_time_of_day *the_tod ); |