~fboucault/paf/documentation_fixes

« back to all changes in this revision

Viewing changes to paf/pafcommon.h

  • Committer: Guillaume Emont
  • Date: 2008-05-22 15:38:43 UTC
  • mfrom: (57.1.17 api-fixing)
  • Revision ID: guillaume@fluendo.com-20080522153843-qx418dc8hes14x1r
Merge with api-fixing.
  Added const and G_GNUC_NULL_TERMINATED where needed.
  Renamed "source" and "progression" to "fraction".

Show diffs side-by-side

added added

removed removed

Lines of Context:
34
34
 
35
35
/**
36
36
 * PafState:
37
 
 * @PAF_STATE_STOPPED: the clock is ignoring all ticks, and will have a
38
 
 * PafClock:progression of 0.0f when started, and reinitialise the time count
39
 
 * regarding PafClock:duration.
 
37
 * @PAF_STATE_STOPPED: the clock is ignoring all ticks, and will reinitialise
 
38
 * the time count used to know where we are regarding PafClock:duration when
 
39
 * changed to PAF_STATE_RUNNING.
40
40
 * @PAF_STATE_RUNNING: the clock is active and doing its job.
41
 
 * @PAF_STATE_PAUSED: the clock is ignoring all ticks, and will remember the
42
 
 * last value of its PafClock:progression and where it is regarding
43
 
 * PafClock:duration when started again.
 
41
 * @PAF_STATE_PAUSED: the clock is ignoring all ticks.
44
42
 * @PAF_LAST_STATE: here for implementation purposes, to check for the
45
43
 * validity of a PafClockStatus.
46
44
 *