diff options
author | lloyd <[email protected]> | 2009-12-24 22:21:25 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2009-12-24 22:21:25 +0000 |
commit | 90394a98550551d882fb4d9610b9b8bfa7271c76 (patch) | |
tree | 93937163fe396e739623366afcaff10f0526b944 | |
parent | ab35e8266cb93df950c0f93a74f9714d9de40f1c (diff) |
Add/fix doxygen comments
-rw-r--r-- | src/utils/time.h | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/src/utils/time.h b/src/utils/time.h index 05fc6c651..bc571120b 100644 --- a/src/utils/time.h +++ b/src/utils/time.h @@ -13,6 +13,9 @@ namespace Botan { +/** +* Struct representing a particular date and time +*/ struct BOTAN_DLL calendar_point { u32bit year; @@ -26,15 +29,19 @@ struct BOTAN_DLL calendar_point year(y), month(mon), day(d), hour(h), minutes(min), seconds(sec) {} }; -/* -* Time Access/Conversion Functions +/** +* @param time_point a time point from the system clock +* @returns calendar_point object representing this time point */ -BOTAN_DLL u64bit system_time(); +BOTAN_DLL calendar_point calendar_value(u64bit time_point); -BOTAN_DLL calendar_point calendar_value(u64bit a_time_t); +/** +* @return seconds resolution timestamp, unknown epoch +*/ +BOTAN_DLL u64bit system_time(); /** -@return nanoseconds resolution timestamp, unknown epoch +* @return nanoseconds resolution timestamp, unknown epoch */ BOTAN_DLL u64bit get_nanoseconds_clock(); |