summaryrefslogtreecommitdiff
path: root/src/lib/dcpomatic_time.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2017-03-02 15:37:13 +0000
committerCarl Hetherington <cth@carlh.net>2017-04-19 23:04:32 +0100
commit67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 (patch)
tree9b1fea4070c3b15f346cc57075bbeed1b963329d /src/lib/dcpomatic_time.h
parent3449bc0a6d6e77e851240a0953363f5a07ec6517 (diff)
Various Doxygen fixes.
Diffstat (limited to 'src/lib/dcpomatic_time.h')
-rw-r--r--src/lib/dcpomatic_time.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/src/lib/dcpomatic_time.h b/src/lib/dcpomatic_time.h
index cc31755cb..8b2bcce05 100644
--- a/src/lib/dcpomatic_time.h
+++ b/src/lib/dcpomatic_time.h
@@ -158,7 +158,13 @@ public:
return ::ceil (_t * double(r) / HZ);
}
- /** @param r Frames per second */
+ /** Split a time into hours, minutes, seconds and frames.
+ * @param r Frames per second.
+ * @param h Returned hours.
+ * @param m Returned minutes.
+ * @param s Returned seconds.
+ * @param f Returned frames.
+ */
template <typename T>
void split (T r, int& h, int& m, int& s, int& f) const
{
@@ -292,7 +298,9 @@ public:
}
};
-/** @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap */
+/** @param A Period which is subtracted from.
+ * @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap.
+ */
template <class T>
std::list<TimePeriod<T> > subtract (TimePeriod<T> A, std::list<TimePeriod<T> > const & B)
{