ardour/livetrax
13
0
Fork 0
Code

NO-OP: doxygenize timepos_t::distance

Browse Source
This commit is contained in:
Robin Gareus 2022-10-31 00:22:21 +01:00
parent 21e8885e00
commit 96bab3ce46
Signed by: rgareus
GPG Key ID: A090BCE02CF57F04
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
libs/temporal/temporal/timeline.h
View File

@ -142,18 +142,19 @@ class LIBTEMPORAL_API timepos_t : public int62_t {
* explicit methods with clear semantics.
*/
/* computes the distance between this timepos_t and @param p
/** Compute the distance between this timepos_t and @param p
* such that: this + distance = p
*
* This means that if @param p is later than this, distance is positive;
* if @param p is earlier than this, distance is negative.
*
* Note that the return value is a timecnt_t whose position member
* is equal to the value of this. That means if the distance uses
* musical time value, the distance may not have constant value
* at other positions on the timeline.
*/
*
* @return this - @param p
*/
timecnt_t distance (timepos_t const & p) const;
/* computes a new position value that is @param d earlier than this */