Comments.

[dcpomatic.git] / src / lib / cross.h

diff --git a/src/lib/cross.h b/src/lib/cross.h
index 1c77545033fdb0c7e2ee17db2a297b9e8100659f..c206fa55dbf3064cf17bcf68e719a45bb1765e2d 100644 (file)
--- a/src/lib/cross.h
+++ b/src/lib/cross.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/lib/cross.h
+ *  @brief Cross-platform compatibility code.
+ */
+
 #ifndef DCPOMATIC_CROSS_H
 #define DCPOMATIC_CROSS_H
 
@@ -42,7 +46,9 @@ extern boost::filesystem::path app_contents ();
 extern FILE * fopen_boost (boost::filesystem::path, std::string);
 extern int dcpomatic_fseek (FILE *, int64_t, int);
 
-/** A class which tries to keep the computer awake on various operating systems.
+/** @class Waker
+ *  @brief A class which tries to keep the computer awake on various operating systems.
+ *
  *  Create a Waker to prevent sleep, and call ::nudge every so often (every minute or so).
  *  Destroy the Waker to allow sleep again.
  */