Comment tweaks.

diff --git a/src/util.cc b/src/util.cc
index 2b3a6c8defac8567cb80593e180fc631924c670b..78ef7676979c6e227ac01fdc5835f94fc8d47390 100644 (file)
--- a/src/util.cc
+++ b/src/util.cc
@@ -43,6 +43,9 @@ using std::max;
 using boost::shared_ptr;
 using namespace libdcp;
 
+/** Create a UUID.
+ *  @return UUID.
+ */
 string
 libdcp::make_uuid ()
 {
@@ -53,6 +56,13 @@ libdcp::make_uuid ()
        return string (buffer);
 }
 
+
+/** Create a digest for a file.
+ *  @param filename File name.
+ *  @param progress If non-0, a signal which will be emitted periodically to update
+ *  progress; the parameter will start at 0.5 and proceed to 1.
+ *  @return Digest.
+ */
 string
 libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* progress)
 {
@@ -94,6 +104,11 @@ libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* pro
        return Kumu::base64encode (byte_buffer, 20, digest, 64);
 }
 
+/** Convert a content kind to a string which is representative,
+ *  but not necessarily human-readable.
+ *  @param kind ContentKind.
+ *  @return string.
+ */
 string
 libdcp::content_kind_to_string (ContentKind kind)
 {

diff --git a/src/util.h b/src/util.h
index 7056db6a372fe4def5fbe0cce8baa83b4a6a5e0a..619c15c5d4b1a627c6e4db866bb4c96f35e3aad5 100644 (file)
--- a/src/util.h
+++ b/src/util.h
@@ -31,25 +31,13 @@ namespace libdcp {
 
 class ARGBFrame;       
        
-/** Create a UUID.
- *  @return UUID.
- */
 extern std::string make_uuid ();
-
-/** Create a digest for a file.
- *  @param filename File name.
- *  @param progress If non-0, a signal which will be emitted periodically to update
- *  progress; the parameter will start at 0.5 and proceed to 1.
- *  @return Digest.
- */
 extern std::string make_digest (std::string filename, boost::signals2::signal<void (float)>* progress);
-
 extern std::string content_kind_to_string (ContentKind kind);
 extern ContentKind content_kind_from_string (std::string kind);
 extern bool starts_with (std::string big, std::string little);
 extern bool ends_with (std::string big, std::string little);
 extern bool empty_or_white_space (std::string s);
-
 extern opj_image_t* decompress_j2k (uint8_t* data, int64_t size, int reduce);
 extern boost::shared_ptr<ARGBFrame> xyz_to_rgb (opj_image_t* xyz_frame);