diff options
| author | Carl Hetherington <cth@carlh.net> | 2015-07-03 17:12:12 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2015-07-03 17:12:12 +0100 |
| commit | faa03caeb082459e0283be39198464f50bef780a (patch) | |
| tree | dc8114e6d06e79958d2a5374bba8157ec27c5b5f /src | |
| parent | 94245f8ccec610d9d7f9a1a7dae0e4d53f917ee8 (diff) | |
A few bits of documentation.
Diffstat (limited to 'src')
| -rw-r--r-- | src/data.cc | 7 | ||||
| -rw-r--r-- | src/data.h | 5 | ||||
| -rw-r--r-- | src/gamma_transfer_function.cc | 4 | ||||
| -rw-r--r-- | src/gamma_transfer_function.h | 7 |
4 files changed, 23 insertions, 0 deletions
diff --git a/src/data.cc b/src/data.cc index 7f390ead..a326ed3b 100644 --- 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"); @@ -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 062599d6..fe560f54 100644 --- 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 282fdfe0..24d65df0 100644 --- 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: |