jiigen666/libtorrent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation polish. hide internal functions and types

Browse Source
This commit is contained in:
Arvid Norberg
2013-07-21 15:47:30 +00:00
parent eb6a964463
commit 2e911ee344
7 changed files with 25 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/gen_reference_doc.py
View File

@@ -74,8 +74,11 @@ def first_item(itr):
return None
def highlight_signature(s):
name = s.split('(')[0].split(' ')[-1].strip()
return s.replace(name, '<strong>' + name + '</strong>')
name = s.split('(')
name2 = name[0].split(' ')
name2[-1] = '<strong>' + name2[-1] + '</strong>'
name[0] = ' '.join(name2)
return '('.join(name)
def html_sanitize(s):
ret = ''
@@ -221,7 +224,7 @@ def parse_class(lno, lines, filename):
if looks_like_function(l):
current_fun, lno = parse_function(lno - 1, lines, filename)
if current_fun != None:
if current_fun != None and context.strip() != 'internal':
if context == '' and blanks == 0 and len(funs):
funs[-1]['signatures'].update(current_fun['signatures'])
funs[-1]['names'].update(current_fun['names'])
@@ -233,6 +236,9 @@ def parse_class(lno, lines, filename):
continue
if looks_like_variable(l):
if context.strip() == 'internal':
context = ''
continue
n = l.split(' ')[-1].split(':')[0].split(';')[0]
if context == '' and blanks == 0 and len(fields):
fields[-1]['names'].append(n)
@@ -245,7 +251,7 @@ def parse_class(lno, lines, filename):
if l.startswith('enum '):
enum, lno = parse_enum(lno - 1, lines, filename)
if enum != None:
if enum != None and context.strip() != 'internal':
enum['desc'] = context
enums.append(enum)
context = ''
@@ -300,7 +306,8 @@ def parse_enum(lno, lines, filename):
if verbose: print 'enumv %s' % lines[lno-1]
for v in l.split(','):
if v == '': continue
values.append({'name': v.strip(), 'desc': context})
if context.strip() != 'internal':
values.append({'name': v.strip(), 'desc': context})
context = ''
else:
if verbose: print '?? %s' % lines[lno-1]
@@ -403,7 +410,7 @@ for filename in files:
if 'TORRENT_EXPORT ' in l:
if 'class ' in l or 'struct ' in l:
current_class, lno = parse_class(lno -1, lines, filename)
if current_class != None:
if current_class != None and context.strip() != 'internal':
current_class['desc'] = context
classes.append(current_class)
context = ''
@@ -412,7 +419,7 @@ for filename in files:
if looks_like_function(l):
current_fun, lno = parse_function(lno - 1, lines, filename)
if current_fun != None:
if current_fun != None and context.strip() != 'internal':
if context == '' and blanks == 0 and len(functions):
functions[-1]['signatures'].update(current_fun['signatures'])
functions[-1]['names'].update(current_fun['names'])
@@ -431,7 +438,7 @@ for filename in files:
if l.startswith('enum '):
current_enum, lno = parse_enum(lno - 1, lines, filename)
if current_enum != None:
if current_enum != None and context.strip() != 'internal':
current_enum['desc'] = context
enums.append(current_enum)
context = ''

9
docs/style.css
View File

@@ -77,14 +77,7 @@ div.section p, div.section ul, div.section dl {
#container {
text-align: left;
width: 700px;
margin: 0 auto;
position: relative;
}
#container {
text-align: left;
width: 700px;
width: 70em;
margin: 0 auto;
position: relative;
}