abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some "\ingroup timestamp" doxy-comments so that they actually appear in the output!

Browse Source
This commit is contained in:
Andrew Scheller 2021-02-25 16:34:52 +00:00 committed by graham sanderson
parent c1c7197757
commit e5d61f1ad3
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/common/pico_base/include/pico/types.h
View File

@ -23,6 +23,7 @@ typedef unsigned int uint;
\see to_us_since_boot \see to_us_since_boot
\see update_us_since_boot \see update_us_since_boot
\ingroup timestamp
*/ */
#ifndef NDEBUG #ifndef NDEBUG
typedef uint64_t absolute_time_t; typedef uint64_t absolute_time_t;
@ -36,6 +37,7 @@ typedef struct {
* \brief convert an absolute_time_t into a number of microseconds since boot. * \brief convert an absolute_time_t into a number of microseconds since boot.
* \param t the absolute time to convert * \param t the absolute time to convert
* \return a number of microseconds since boot, equivalent to t * \return a number of microseconds since boot, equivalent to t
* \ingroup timestamp
*/ */
static inline uint64_t to_us_since_boot(absolute_time_t t) { static inline uint64_t to_us_since_boot(absolute_time_t t) {
#ifndef NDEBUG #ifndef NDEBUG
@ -50,6 +52,7 @@ static inline uint64_t to_us_since_boot(absolute_time_t t) {
* \param t the absolute time value to update * \param t the absolute time value to update
* \param us_since_boot the number of microseconds since boot to represent. Note this should be representable * \param us_since_boot the number of microseconds since boot to represent. Note this should be representable
* as a signed 64 bit integer * as a signed 64 bit integer
* \ingroup timestamp
*/ */
static inline void update_us_since_boot(absolute_time_t *t, uint64_t us_since_boot) { static inline void update_us_since_boot(absolute_time_t *t, uint64_t us_since_boot) {
#ifndef NDEBUG #ifndef NDEBUG