Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / cross.h
index 1c77545033fdb0c7e2ee17db2a297b9e8100659f..fee68cedc6f05bf220d11b7b1307f43ed16e9b48 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 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
 
 */
 
+/** @file  src/lib/cross.h
+ *  @brief Cross-platform compatibility code.
+ */
+
 #ifndef DCPOMATIC_CROSS_H
 #define DCPOMATIC_CROSS_H
 
-#include <boost/filesystem.hpp>
 #ifdef DCPOMATIC_OSX
 #include <IOKit/pwr_mgt/IOPMLib.h>
 #endif
+#include <boost/filesystem.hpp>
 
 #ifdef DCPOMATIC_WINDOWS
 #define WEXITSTATUS(w) (w)
@@ -39,10 +43,13 @@ extern boost::filesystem::path openssl_path ();
 #ifdef DCPOMATIC_OSX
 extern boost::filesystem::path app_contents ();
 #endif
+extern boost::filesystem::path shared_path ();
 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.
  */