From f0631e91aed959105fc80aa0ae9e5c926468cb71 Mon Sep 17 00:00:00 2001 From: Arvid Norberg Date: Wed, 27 Nov 2013 20:57:19 +0000 Subject: [PATCH] documentation polish --- include/libtorrent/entry.hpp | 7 +++++++ include/libtorrent/lazy_entry.hpp | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/include/libtorrent/entry.hpp b/include/libtorrent/entry.hpp index 8b662d2c6..2fc1ee57e 100644 --- a/include/libtorrent/entry.hpp +++ b/include/libtorrent/entry.hpp @@ -128,11 +128,18 @@ namespace libtorrent // hidden entry(entry const& e); + + // hidden entry(); + + // hidden ~entry(); // hidden bool operator==(entry const& e) const; + + // copies the structure of the right hand side into this + // entry. void operator=(lazy_entry const&); void operator=(entry const&); void operator=(dictionary_type const&); diff --git a/include/libtorrent/lazy_entry.hpp b/include/libtorrent/lazy_entry.hpp index b26002eb0..8a9f09b3a 100644 --- a/include/libtorrent/lazy_entry.hpp +++ b/include/libtorrent/lazy_entry.hpp @@ -161,7 +161,7 @@ namespace libtorrent m_len = length + 2; // include 'e' } - // if this is an integer, return the integer value + // requires the type to be an integer. return the integer value boost::int64_t int_value() const; // internal @@ -307,7 +307,7 @@ namespace libtorrent return int(m_size); } - // end points one byte passed last byte in the source + // internal: end points one byte passed last byte in the source // buffer backing the bencoded structure. void set_end(char const* end) { @@ -318,7 +318,7 @@ namespace libtorrent // internal void clear(); - // releases ownership of any memory allocated + // internal: releases ownership of any memory allocated void release() { m_data.start = 0;