docs: restrict the set of characters for info keys

When parsing the top level comment of a file, apibuild.py used
to split on any ':' character of a line regarding the first part
as a key for a setting, e.g. "Summary". The second part would then
be assigned as the value for that key.

This means you could not use a ':' character inside those comments
without ill effects.

Now, a key must consist solely of alphanumeric characters, '_' or '.'.
This commit is contained in:
Claudio Bley 2013-01-11 11:39:19 +01:00
parent 833e1493ed
commit bf1786b6d5

View File

@ -10,6 +10,7 @@
import os, sys
import string
import glob
import re
quiet=True
warnings=0
@ -655,20 +656,17 @@ class CParser:
item = None
for line in lines:
line = line.lstrip().lstrip('*').lstrip()
try:
(it, line) = string.split(line, ":", 1)
item = it
line = line.lstrip()
m = re.match('([_.a-zA-Z0-9]+):(.*)', line)
if m:
item = m.group(1)
line = m.group(2).lstrip()
if item:
if res.has_key(item):
res[item] = res[item] + " " + line
else:
res[item] = line
except:
if item != None:
if res.has_key(item):
res[item] = res[item] + " " + line
else:
res[item] = line
self.index.info = res
def strip_lead_star(self, line):