Improved comments.

[libdcp.git] / src / gamma_transfer_function.h

diff --git a/src/gamma_transfer_function.h b/src/gamma_transfer_function.h
index 01f2831ac57c9b253715b8d03930ae547e286495..a7bdd44d940e157302ad04df774a78809c964bd8 100644 (file)
--- a/src/gamma_transfer_function.h
+++ b/src/gamma_transfer_function.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -15,29 +15,47 @@
 
     You should have received a copy of the GNU General Public License
     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
 /** @file  src/gamma_transfer_function.h
- *  @brief GammaTransferFunction class.
+ *  @brief GammaTransferFunction class
  */
 
+
 #include "transfer_function.h"
 
+
 namespace dcp {
 
-/** A description of a gamma function of the f(x) = x^g where
- *  g is the gamma.
+
+/** @class GammaTransferFunction
+ *  @brief A description of a gamma function of the f(x) = x^g where g is the gamma
  */
 class GammaTransferFunction : public TransferFunction
 {
 public:
-       GammaTransferFunction (double gamma);
+       explicit GammaTransferFunction (double gamma);
 
        double gamma () const {
                return _gamma;
        }
 
-       bool about_equal (boost::shared_ptr<const TransferFunction> other, double epsilon) const;
+       bool about_equal (std::shared_ptr<const TransferFunction> other, double epsilon) const;
 
 protected:
        double * make_lut (int bit_depth, bool inverse) const;
@@ -46,4 +64,5 @@ private:
        double _gamma;
 };
 
+
 }