From e530b2e36d7646f7fd7bd0ca0ebcc0a40ddf52c1 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Mon, 23 Jul 2018 02:04:30 +0100 Subject: [PATCH] Commenting. --- src/lib/audio_delay.h | 3 +++ src/lib/player.h | 2 +- src/lib/ratio.h | 5 ++++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/lib/audio_delay.h b/src/lib/audio_delay.h index 22be33478..44e8c009b 100644 --- a/src/lib/audio_delay.h +++ b/src/lib/audio_delay.h @@ -22,6 +22,9 @@ class AudioBuffers; +/** @class AudioDelay + * @brief An audio delay line. + */ class AudioDelay { public: diff --git a/src/lib/player.h b/src/lib/player.h index 8b85a011f..c086b9697 100644 --- a/src/lib/player.h +++ b/src/lib/player.h @@ -59,7 +59,7 @@ public: }; /** @class Player - * @brief A class which can `play' a Playlist. + * @brief A class which can play a Playlist. */ class Player : public boost::enable_shared_from_this, public boost::noncopyable { diff --git a/src/lib/ratio.h b/src/lib/ratio.h index a6f2bbd73..40f596ab8 100644 --- a/src/lib/ratio.h +++ b/src/lib/ratio.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2013 Carl Hetherington + Copyright (C) 2013-2018 Carl Hetherington This file is part of DCP-o-matic. @@ -25,6 +25,9 @@ #include #include +/** @class Ratio + * @brief Description of an image ratio. + */ class Ratio : public boost::noncopyable { public: -- 2.30.2