added documentations to headers

2013-08-16 05:07:09 +00:00
parent 1b60710493
commit 3258d92f64
11 changed files with 117 additions and 17 deletions
--- a/include/libtorrent/thread.hpp
+++ b/include/libtorrent/thread.hpp
@@ -57,6 +57,8 @@ namespace libtorrent
 	typedef boost::asio::detail::mutex mutex;
 	typedef boost::asio::detail::event event;

+	// pauses the calling thread at least for the specified
+	// number of milliseconds
 	TORRENT_EXPORT void sleep(int milliseconds);

 	struct TORRENT_EXTRA_EXPORT condition_variable