From faa03caeb082459e0283be39198464f50bef780a Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Fri, 3 Jul 2015 17:12:12 +0100 Subject: A few bits of documentation. --- src/data.cc | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'src/data.cc') 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"); -- cgit v1.2.3