more documentation polishing

This commit is contained in:
Arvid Norberg 2013-07-25 05:08:35 +00:00
parent d6bc6aa659
commit b759982cf6
3 changed files with 11 additions and 9 deletions

View File

@ -57,6 +57,7 @@ category_mapping = {
'peer_id.hpp': 'Utility', 'peer_id.hpp': 'Utility',
'identify_client.hpp': 'Utility', 'identify_client.hpp': 'Utility',
'thread.hpp': 'Utility', 'thread.hpp': 'Utility',
'ip_filter.hpp': 'Filter',
} }
def categorize_symbol(name, filename): def categorize_symbol(name, filename):
@ -530,7 +531,7 @@ for c in classes:
categories[cat]['overview'] = overviews[c['file']] categories[cat]['overview'] = overviews[c['file']]
categories[cat]['classes'].append(c) categories[cat]['classes'].append(c)
symbols[c['name']] = categories[cat]['filename'].replace('.rst', '.html') + '#' + html_sanitize(c['name']) symbols[c['name']] = categories[cat]['filename'].replace('.rst', '.html') + '#' + c['name']
for f in functions: for f in functions:
cat = categorize_symbol(first_item(f['names']), f['file']) cat = categorize_symbol(first_item(f['names']), f['file'])
@ -541,7 +542,7 @@ for f in functions:
categories[cat]['overview'] = overviews[f['file']] categories[cat]['overview'] = overviews[f['file']]
for n in f['names']: for n in f['names']:
symbols[n] = categories[cat]['filename'].replace('.rst', '.html') + '#' + html_sanitize(n) symbols[n] = categories[cat]['filename'].replace('.rst', '.html') + '#' + n
categories[cat]['functions'].append(f) categories[cat]['functions'].append(f)
for e in enums: for e in enums:
@ -549,7 +550,7 @@ for e in enums:
if not cat in categories: if not cat in categories:
categories[cat] = { 'classes': [], 'functions': [], 'enums': [], 'filename': 'reference-%s.rst' % cat.replace(' ', '_')} categories[cat] = { 'classes': [], 'functions': [], 'enums': [], 'filename': 'reference-%s.rst' % cat.replace(' ', '_')}
categories[cat]['enums'].append(e) categories[cat]['enums'].append(e)
symbols[e['name']] = categories[cat]['filename'].replace('.rst', '.html') + '#' + html_sanitize(e['name']) symbols[e['name']] = categories[cat]['filename'].replace('.rst', '.html') + '#' + e['name']
def print_declared_in(out, o): def print_declared_in(out, o):
out.write('Declared in "%s"\n\n' % print_link(o['file'], '../include/%s' % o['file'])) out.write('Declared in "%s"\n\n' % print_link(o['file'], '../include/%s' % o['file']))

View File

@ -34,7 +34,8 @@ TARGETS = index \
reference-Utility \ reference-Utility \
reference-Bencoding \ reference-Bencoding \
reference-Alerts \ reference-Alerts \
reference-RSS reference-RSS \
reference-Filter
FIGURES = read_disk_buffers write_disk_buffers troubleshooting FIGURES = read_disk_buffers write_disk_buffers troubleshooting

View File

@ -195,35 +195,35 @@ namespace libtorrent
return ret; return ret;
} }
big_number operator^ (big_number const& n) const big_number operator^(big_number const& n) const
{ {
big_number ret = *this; big_number ret = *this;
ret ^= n; ret ^= n;
return ret; return ret;
} }
big_number operator& (big_number const& n) const big_number operator&(big_number const& n) const
{ {
big_number ret = *this; big_number ret = *this;
ret &= n; ret &= n;
return ret; return ret;
} }
big_number& operator &= (big_number const& n) big_number& operator&=(big_number const& n)
{ {
for (int i = 0; i< number_size; ++i) for (int i = 0; i< number_size; ++i)
m_number[i] &= n.m_number[i]; m_number[i] &= n.m_number[i];
return *this; return *this;
} }
big_number& operator |= (big_number const& n) big_number& operator|=(big_number const& n)
{ {
for (int i = 0; i< number_size; ++i) for (int i = 0; i< number_size; ++i)
m_number[i] |= n.m_number[i]; m_number[i] |= n.m_number[i];
return *this; return *this;
} }
big_number& operator ^= (big_number const& n) big_number& operator^=(big_number const& n)
{ {
for (int i = 0; i< number_size; ++i) for (int i = 0; i< number_size; ++i)
m_number[i] ^= n.m_number[i]; m_number[i] ^= n.m_number[i];