Skip to content

Commit

Permalink
clockadj: make Doxygen comment by using two stars.
Browse files Browse the repository at this point in the history
Signed-off-by: Richard Cochran <[email protected]>
  • Loading branch information
richardcochran committed Apr 9, 2013
1 parent 76e10e9 commit 4a6ef24
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions clockadj.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,36 +23,36 @@
#include <inttypes.h>
#include <time.h>

/*
/**
* Set clock's frequency offset.
* @param clkid A clock ID obtained using phc_open() or CLOCK_REALTIME.
* @param freq The frequency offset in parts per billion (ppb).
*/
void clockadj_set_freq(clockid_t clkid, double freq);

/*
/**
* Read clock's frequency offset.
* @param clkid A clock ID obtained using phc_open() or CLOCK_REALTIME.
* @return The frequency offset in parts per billion (ppb).
*/
double clockadj_get_freq(clockid_t clkid);

/*
/**
* Step clock's time.
* @param clkid A clock ID obtained using phc_open() or CLOCK_REALTIME.
* @param step The time step in nanoseconds.
*/
void clockadj_step(clockid_t clkid, int64_t step);

/*
/**
* Insert/delete leap second at midnight.
* @param clkid CLOCK_REALTIME.
* @param leap +1 to insert leap second, -1 to delete leap second,
* 0 to reset the leap state.
*/
void clockadj_set_leap(clockid_t clkid, int leap);

/*
/**
* Read clock's maximum frequency adjustment.
* @param clkid CLOCK_REALTIME.
* @return The maximum frequency adjustment in parts per billion (ppb).
Expand Down

0 comments on commit 4a6ef24

Please sign in to comment.