A few bits of documentation.

diff --git a/src/data.cc b/src/data.cc
index 7f390ead2c31b59cd4cd29956fef5a39348c879d..a326ed3b7e3b3fcb2dc958425ed55b368679b075 100644 (file)
--- a/src/data.cc
+++ b/src/data.cc
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/data.cc
+ *  @brief Data class.
+ */
+
 #include "data.h"
 #include "util.h"
 #include "exceptions.h"
@@ -24,6 +28,9 @@
 
 using namespace dcp;
 
+/** Construct a Data object from the contents of a file.
+ *  @param file File to read.
+ */
 Data::Data (boost::filesystem::path file)
 {
        FILE* f = fopen_boost (file, "rb");

diff --git a/src/data.h b/src/data.h
index 3cece1daceb65e056c21341df777ee04b187c1a8..0b746052a6e23cb45b21fa27bb10650c510cf36a 100644 (file)
--- a/src/data.h
+++ b/src/data.h
@@ -17,12 +17,17 @@
 
 */
 
+/** @file  src/data.h
+ *  @brief Data class.
+ */
+
 #include <boost/shared_array.hpp>
 #include <boost/filesystem.hpp>
 #include <stdint.h>
 
 namespace dcp {
 
+/** A block of arbitrary data */
 class Data
 {
 public:

diff --git a/src/gamma_transfer_function.cc b/src/gamma_transfer_function.cc
index 062599d6569e877753e2321e9d6c27890c002bf0..fe560f548962613d2c21fb32b3969f5c3d77c891 100644 (file)
--- a/src/gamma_transfer_function.cc
+++ b/src/gamma_transfer_function.cc
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/gamma_transfer_function.cc
+ *  @brief GammaTransferFunction class.
+ */
+
 #include "gamma_transfer_function.h"
 #include <cmath>
 

diff --git a/src/gamma_transfer_function.h b/src/gamma_transfer_function.h
index 282fdfe01ccfd021e2c6dd78d76a34ceeb601e77..24d65df0a1309e4586441af116bf9a74e770e50f 100644 (file)
--- a/src/gamma_transfer_function.h
+++ b/src/gamma_transfer_function.h
@@ -17,10 +17,17 @@
 
 */
 
+/** @file  src/gamma_transfer_function.h
+ *  @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 : public TransferFunction
 {
 public: