summaryrefslogtreecommitdiff
path: root/doc/tools
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2016-04-02 20:26:12 +0200
committerRémi Verschelde <remi@verschelde.fr>2016-04-02 20:26:12 +0200
commit0a5472e697dee57956c2583a50bc5cf5faada5d8 (patch)
tree62e9d9616c9529cee5c6c85e18415bc8745966fe /doc/tools
parent48f057ea816f4ae4b917cb110e399fcbfb4234a0 (diff)
Remove trailing spaces
Diffstat (limited to 'doc/tools')
-rw-r--r--doc/tools/doc_merge.py52
-rw-r--r--doc/tools/main.css4
-rw-r--r--doc/tools/makedoku.py224
-rw-r--r--doc/tools/makehtml.py262
-rw-r--r--doc/tools/makemd.py4
-rw-r--r--doc/tools/makerst.py22
6 files changed, 284 insertions, 284 deletions
diff --git a/doc/tools/doc_merge.py b/doc/tools/doc_merge.py
index 6cc7019324..b55902ce4f 100644
--- a/doc/tools/doc_merge.py
+++ b/doc/tools/doc_merge.py
@@ -30,7 +30,7 @@ def escape(ret):
ret=ret.replace("'","&apos;");
ret=ret.replace("\"","&quot;");
return ret
-
+
def inc_tab():
global tab
@@ -50,34 +50,34 @@ def get_tag(node,name):
return tag
def find_method_descr(old_class,name):
-
- methods = old_class.find("methods")
+
+ methods = old_class.find("methods")
if(methods!=None and len(list(methods))>0):
for m in list(methods):
if (m.attrib["name"]==name):
description=m.find("description")
if (description!=None and description.text.strip()!=""):
return description.text
-
+
return None
def find_signal_descr(old_class,name):
-
- signals = old_class.find("signals")
+
+ signals = old_class.find("signals")
if(signals!=None and len(list(signals))>0):
for m in list(signals):
if (m.attrib["name"]==name):
description=m.find("description")
if (description!=None and description.text.strip()!=""):
return description.text
-
+
return None
def find_constant_descr(old_class,name):
if (old_class==None):
- return None
- constants = old_class.find("constants")
+ return None
+ constants = old_class.find("constants")
if(constants!=None and len(list(constants))>0):
for m in list(constants):
if (m.attrib["name"]==name):
@@ -98,31 +98,31 @@ def write_class(c):
inherits=get_tag(c,"inherits")
write_string(f,'<class name="'+class_name+'" '+category+inherits+'>')
inc_tab()
-
+
write_string(f,"<brief_description>")
if (old_class!=None):
old_brief_descr=old_class.find("brief_description")
if (old_brief_descr!=None):
write_string(f,escape(old_brief_descr.text.strip()))
-
-
+
+
write_string(f,"</brief_description>")
-
+
write_string(f,"<description>")
if (old_class!=None):
old_descr=old_class.find("description")
if (old_descr!=None):
write_string(f,escape(old_descr.text.strip()))
-
+
write_string(f,"</description>")
- methods = c.find("methods")
+ methods = c.find("methods")
if(methods!=None and len(list(methods))>0):
write_string(f,"<methods>")
inc_tab()
-
+
for m in list(methods):
qualifiers=get_tag(m,"qualifiers")
@@ -135,7 +135,7 @@ def write_class(c):
write_string(f,'<return'+typ+'>');
write_string(f,'</return>');
elif (a.tag=="argument"):
-
+
default=get_tag(a,"default")
write_string(f,'<argument index="'+a.attrib["index"]+'" name="'+escape(a.attrib["name"])+'" type="'+a.attrib["type"]+'"' +default+'>');
@@ -146,20 +146,20 @@ def write_class(c):
old_method_descr=find_method_descr(old_class,m.attrib["name"])
if (old_method_descr):
write_string(f,escape(escape(old_method_descr.strip())))
-
+
write_string(f,'</description>');
- dec_tab()
+ dec_tab()
write_string(f,"</method>")
dec_tab()
write_string(f,"</methods>")
- signals = c.find("signals")
+ signals = c.find("signals")
if(signals!=None and len(list(signals))>0):
write_string(f,"<signals>")
inc_tab()
-
- for m in list(signals):
+
+ for m in list(signals):
write_string(f,'<signal name="'+escape(m.attrib["name"])+'">')
inc_tab()
@@ -176,18 +176,18 @@ def write_class(c):
if (old_signal_descr):
write_string(f,escape(old_signal_descr.strip()))
write_string(f,'</description>');
- dec_tab()
+ dec_tab()
write_string(f,"</signal>")
dec_tab()
write_string(f,"</signals>")
- constants = c.find("constants")
+ constants = c.find("constants")
if(constants!=None and len(list(constants))>0):
write_string(f,"<constants>")
inc_tab()
-
- for m in list(constants):
+
+ for m in list(constants):
write_string(f,'<constant name="'+escape(m.attrib["name"])+'" value="'+m.attrib["value"]+'">')
old_constant_descr=find_constant_descr(old_class,m.attrib["name"])
diff --git a/doc/tools/main.css b/doc/tools/main.css
index a76e6bbed8..5eb3df2159 100644
--- a/doc/tools/main.css
+++ b/doc/tools/main.css
@@ -29,12 +29,12 @@ div.method_description {
list.inh_class_list {
margin-left: 30px;
-
+
}
div.inh_class_list {
margin-left: 30px;
-
+
}
div.method_doc div.method {
diff --git a/doc/tools/makedoku.py b/doc/tools/makedoku.py
index 1ab16841b1..97819d7da3 100644
--- a/doc/tools/makedoku.py
+++ b/doc/tools/makedoku.py
@@ -19,14 +19,14 @@ def validate_tag(elem,tag):
if (elem.tag != tag):
print("Tag mismatch, expected '"+tag+"', got "+elem.tag);
sys.exit(255)
-
+
class_names=[]
classes={}
def make_class_list(class_list,columns):
-
+
f=open("class_list.txt","wb")
prev=0
col_max = len(class_list) / columns + 1
@@ -35,13 +35,13 @@ def make_class_list(class_list,columns):
row_count = 0
last_initial = ""
fit_columns=[]
-
+
for n in range(0,columns):
fit_columns+=[[]]
indexers=[]
last_initial=""
-
+
idx=0
for n in class_list:
col = idx/col_max
@@ -52,36 +52,36 @@ def make_class_list(class_list,columns):
if (n[:1]!=last_initial):
indexers+=[n]
last_initial=n[:1]
-
+
row_max=0
-
+
for n in range(0,columns):
if (len(fit_columns[n])>row_max):
row_max=len(fit_columns[n])
-
+
for r in range(0,row_max):
s="|"
- for c in range(0,columns):
+ for c in range(0,columns):
if (r>=len(fit_columns[c])):
continue
-
+
classname = fit_columns[c][r]
initial=classname[0]
if (classname in indexers):
s+="**"+initial+"**|"
else:
s+=" |"
-
+
s+="[["+classname.lower()+"|"+classname+"]]|"
-
+
s+="\n"
f.write(s)
-
-
+
+
def dokuize_text(txt):
-
+
return txt
@@ -95,13 +95,13 @@ def dokuize_text(text):
endq_pos=text.find("]",pos+1)
if (endq_pos==-1):
break
-
+
pre_text=text[:pos]
post_text=text[endq_pos+1:]
tag_text=text[pos+1:endq_pos]
if (tag_text in class_names):
- tag_text="[["+tag_text.lower()+"|"+tag_text+"]]"
+ tag_text="[["+tag_text.lower()+"|"+tag_text+"]]"
else: #command
cmd=tag_text
space_pos=tag_text.find(" ")
@@ -112,7 +112,7 @@ def dokuize_text(text):
elif(cmd.find("method")==0):
cmd=tag_text[:space_pos]
param=tag_text[space_pos+1:]
-
+
if (param.find(".")!=-1):
class_param,method_param=param.split(".")
tag_text="[["+class_param.lower()+"#"+method_param+"|"+class_param+'.'+method_param+"]]"
@@ -123,7 +123,7 @@ def dokuize_text(text):
elif (cmd.find("url=")==0):
tag_text="[["+cmd[4:]+"|"
elif (cmd=="/url"):
- tag_text="]]>"
+ tag_text="]]>"
elif (cmd=="center"):
tag_text=""
elif (cmd=="/center"):
@@ -138,25 +138,25 @@ def dokuize_text(text):
tag_text="__"
else:
tag_text="["+tag_text+"]"
-
-
+
+
text=pre_text+tag_text+post_text
pos=len(pre_text)+len(tag_text)
-
+
#tnode = ET.SubElement(parent,"div")
#tnode.text=text
return text
-
-
+
+
def make_type(t):
global class_names
if (t in class_names):
return "[["+t.lower()+"|"+t+"]]"
return t
-
-
+
+
def make_method(f,name,m,declare,event=False):
-
+
s=" * "
ret_type="void"
args=list(m)
@@ -169,66 +169,66 @@ def make_method(f,name,m,declare,event=False):
idx=int(a.attrib["index"])
else:
continue
-
+
mdata["argidx"].append(idx)
mdata[idx]=a
-
-
- if (not event):
+
+
+ if (not event):
if (-1 in mdata["argidx"]):
s+=make_type(mdata[-1].attrib["type"])
- else:
+ else:
s+="void"
s+=" "
-
+
if (declare):
-
+
#span.attrib["class"]="funcdecl"
#a=ET.SubElement(span,"a")
#a.attrib["name"]=name+"_"+m.attrib["name"]
#a.text=name+"::"+m.attrib["name"]
s+="**"+m.attrib["name"]+"**"
- else:
+ else:
s+="[[#"+m.attrib["name"]+"|"+m.attrib["name"]+"]]"
-
+
s+="**(**"
argfound=False
for a in mdata["argidx"]:
arg=mdata[a]
if (a<0):
continue
- if (a>0):
+ if (a>0):
s+=", "
else:
s+=" "
-
+
s+=make_type(arg.attrib["type"])
if ("name" in arg.attrib):
s+=" "+arg.attrib["name"]
else:
s+=" arg"+str(a)
-
+
if ("default" in arg.attrib):
s+="="+arg.attrib["default"]
-
-
+
+
argfound=True
-
+
if (argfound):
s+=" "
s+="**)**"
-
+
if ("qualifiers" in m.attrib):
s+=" "+m.attrib["qualifiers"]
-
+
f.write(s+"\n")
-
-
+
+
def make_doku_class(node):
name = node.attrib["name"]
-
+
f=open(name.lower()+".txt","wb")
f.write("====== "+name+" ======\n")
@@ -238,26 +238,26 @@ def make_doku_class(node):
f.write("**Inherits:** [["+inh.lower()+"|"+inh+"]]\\\\\n")
if ("category" in node.attrib):
f.write("**Category:** "+node.attrib["category"].strip()+"\\\\\n")
-
+
briefd = node.find("brief_description")
if (briefd!=None):
f.write("===== Brief Description ======\n")
f.write( dokuize_text(briefd.text.strip())+"\n" )
-
- methods = node.find("methods")
-
+
+ methods = node.find("methods")
+
if(methods!=None and len(list(methods))>0):
f.write("===== Member Functions ======\n")
for m in list(methods):
make_method(f,node.attrib["name"],m,False)
-
- events = node.find("signals")
- if(events!=None and len(list(events))>0):
+
+ events = node.find("signals")
+ if(events!=None and len(list(events))>0):
f.write("===== Signals ======\n")
for m in list(events):
make_method(f,node.attrib["name"],m,True,True)
-
- members = node.find("members")
+
+ members = node.find("members")
if(members!=None and len(list(members))>0):
f.write("===== Member Variables ======\n")
@@ -269,33 +269,33 @@ def make_doku_class(node):
if (c.text.strip()!=""):
s+=" - "+c.text.strip()
f.write(s+"\n")
-
-
-
- constants = node.find("constants")
+
+
+
+ constants = node.find("constants")
if(constants!=None and len(list(constants))>0):
f.write("===== Numeric Constants ======\n")
for c in list(constants):
s = " * "
s+="**"+c.attrib["name"]+"**"
if ("value" in c.attrib):
- s+=" = **"+c.attrib["value"]+"**"
+ s+=" = **"+c.attrib["value"]+"**"
if (c.text.strip()!=""):
s+=" - "+c.text.strip()
f.write(s+"\n")
-
-
+
+
descr=node.find("description")
if (descr!=None and descr.text.strip()!=""):
f.write("===== Description ======\n")
f.write(dokuize_text(descr.text.strip())+"\n")
- methods = node.find("methods")
-
+ methods = node.find("methods")
+
if(methods!=None and len(list(methods))>0):
f.write("===== Member Function Description ======\n")
for m in list(methods):
-
+
d=m.find("description")
if (d==None or d.text.strip()==""):
continue
@@ -304,18 +304,18 @@ def make_doku_class(node):
f.write("\\\\\n")
f.write(dokuize_text(d.text.strip()))
f.write("\n")
-
-
-
-
+
+
+
+
"""
div=ET.Element("div")
div.attrib["class"]="class";
a=ET.SubElement(div,"a")
a.attrib["name"]=node.attrib["name"]
-
+
h3=ET.SubElement(a,"h3")
h3.attrib["class"]="title class_title"
h3.text=node.attrib["name"]
@@ -325,63 +325,63 @@ def make_doku_class(node):
div2=ET.SubElement(div,"div")
div2.attrib["class"]="description class_description"
div2.text=briefd.text
-
+
if ("inherits" in node.attrib):
ET.SubElement(div,"br")
- div2=ET.SubElement(div,"div")
+ div2=ET.SubElement(div,"div")
div2.attrib["class"]="inheritance";
span=ET.SubElement(div2,"span")
span.text="Inherits: "
-
+
make_type(node.attrib["inherits"],div2)
-
+
if ("category" in node.attrib):
ET.SubElement(div,"br")
-
- div3=ET.SubElement(div,"div")
+
+ div3=ET.SubElement(div,"div")
div3.attrib["class"]="category";
-
+
span=ET.SubElement(div3,"span")
span.attrib["class"]="category"
span.text="Category: "
-
+
a = ET.SubElement(div3,"a")
a.attrib["class"]="category_ref"
a.text=node.attrib["category"]
catname=a.text
if (catname.rfind("/")!=-1):
- catname=catname[catname.rfind("/"):]
+ catname=catname[catname.rfind("/"):]
catname="CATEGORY_"+catname
-
+
if (single_page):
a.attrib["href"]="#"+catname
else:
a.attrib["href"]="category.html#"+catname
-
-
- methods = node.find("methods")
-
+
+
+ methods = node.find("methods")
+
if(methods!=None and len(list(methods))>0):
h4=ET.SubElement(div,"h4")
h4.text="Public Methods:"
- method_table=ET.SubElement(div,"table")
+ method_table=ET.SubElement(div,"table")
method_table.attrib["class"]="method_list";
for m in list(methods):
# li = ET.SubElement(div2, "li")
method_table.append( make_method_def(node.attrib["name"],m,False) )
- events = node.find("signals")
-
+ events = node.find("signals")
+
if(events!=None and len(list(events))>0):
h4=ET.SubElement(div,"h4")
h4.text="Events:"
- event_table=ET.SubElement(div,"table")
+ event_table=ET.SubElement(div,"table")
event_table.attrib["class"]="method_list";
for m in list(events):
@@ -389,20 +389,20 @@ def make_doku_class(node):
event_table.append( make_method_def(node.attrib["name"],m,False,True) )
- members = node.find("members")
+ members = node.find("members")
if(members!=None and len(list(members))>0):
h4=ET.SubElement(div,"h4")
h4.text="Public Variables:"
- div2=ET.SubElement(div,"div")
+ div2=ET.SubElement(div,"div")
div2.attrib["class"]="member_list";
-
+
for c in list(members):
-
+
li = ET.SubElement(div2, "li")
div3=ET.SubElement(li,"div")
div3.attrib["class"]="member";
- make_type(c.attrib["type"],div3)
+ make_type(c.attrib["type"],div3)
span=ET.SubElement(div3,"span")
span.attrib["class"]="identifier member_name"
span.text=" "+c.attrib["name"]+" "
@@ -411,19 +411,19 @@ def make_doku_class(node):
span.text=c.text
- constants = node.find("constants")
+ constants = node.find("constants")
if(constants!=None and len(list(constants))>0):
h4=ET.SubElement(div,"h4")
h4.text="Constants:"
- div2=ET.SubElement(div,"div")
+ div2=ET.SubElement(div,"div")
div2.attrib["class"]="constant_list";
-
+
for c in list(constants):
li = ET.SubElement(div2, "li")
div3=ET.SubElement(li,"div")
div3.attrib["class"]="constant";
-
+
span=ET.SubElement(div3,"span")
span.attrib["class"]="identifier constant_name"
span.text=c.attrib["name"]+" "
@@ -437,23 +437,23 @@ def make_doku_class(node):
span=ET.SubElement(div3,"span")
span.attrib["class"]="constant_description"
span.text=c.text
-
+
# ET.SubElement(div,"br")
-
-
+
+
descr=node.find("description")
if (descr!=None and descr.text.strip()!=""):
h4=ET.SubElement(div,"h4")
h4.text="Description:"
-
+
make_text_def(node.attrib["name"],div,descr.text)
-# div2=ET.SubElement(div,"div")
+# div2=ET.SubElement(div,"div")
# div2.attrib["class"]="description";
# div2.text=descr.text
-
-
-
+
+
+
if(methods!=None or events!=None):
h4=ET.SubElement(div,"h4")
@@ -467,7 +467,7 @@ def make_doku_class(node):
for m in iter_list:
descr=m.find("description")
-
+
if (descr==None or descr.text.strip()==""):
continue;
@@ -479,11 +479,11 @@ def make_doku_class(node):
#anchor = ET.SubElement(div2, "a")
#anchor.attrib["name"] =
make_text_def(node.attrib["name"],div2,descr.text)
- #div3=ET.SubElement(div2,"div")
+ #div3=ET.SubElement(div2,"div")
#div3.attrib["class"]="description";
#div3.text=descr.text
-
-
+
+
return div
"""
for file in input_list:
@@ -501,14 +501,14 @@ for file in input_list:
continue
class_names.append(c.attrib["name"])
classes[c.attrib["name"]]=c
-
+
class_names.sort()
-
+
make_class_list(class_names,4)
for cn in class_names:
c=classes[cn]
make_doku_class(c)
-
+
diff --git a/doc/tools/makehtml.py b/doc/tools/makehtml.py
index 34db47e424..26edda0935 100644
--- a/doc/tools/makehtml.py
+++ b/doc/tools/makehtml.py
@@ -43,21 +43,21 @@ def validate_tag(elem,tag):
def make_html_bottom(body):
#make_html_top(body,True)
- ET.SubElement(body,"hr")
- copyright = ET.SubElement(body,"span")
+ ET.SubElement(body,"hr")
+ copyright = ET.SubElement(body,"span")
copyright.text = "Copyright 2008-2010 Codenix SRL"
-
+
def make_html_top(body,bottom=False):
if (bottom):
ET.SubElement(body,"hr")
-
- table = ET.SubElement(body,"table")
+
+ table = ET.SubElement(body,"table")
table.attrib["class"]="top_table"
tr = ET.SubElement(table,"tr")
td = ET.SubElement(tr,"td")
td.attrib["class"]="top_table"
-
+
img = ET.SubElement(td,"image")
img.attrib["src"]="images/logo.png"
td = ET.SubElement(tr,"td")
@@ -81,18 +81,18 @@ def make_html_top(body,bottom=False):
a.text="Inheritance"
if (not bottom):
ET.SubElement(body,"hr")
-
-
-
+
+
+
def make_html_class_list(class_list,columns):
-
+
div=ET.Element("div")
div.attrib["class"]="ClassList";
-
+
h1=ET.SubElement(div,"h2")
h1.text="Alphabetical Class List"
-
+
table=ET.SubElement(div,"table")
table.attrib["class"]="class_table"
table.attrib["width"]="100%"
@@ -104,13 +104,13 @@ def make_html_class_list(class_list,columns):
row_count = 0
last_initial = ""
fit_columns=[]
-
+
for n in range(0,columns):
fit_columns+=[[]]
indexers=[]
last_initial=""
-
+
idx=0
for n in class_list:
col = int(idx/col_max)
@@ -123,25 +123,25 @@ def make_html_class_list(class_list,columns):
last_initial=n[:1]
row_max=0
-
+
for n in range(0,columns):
if (len(fit_columns[n])>row_max):
row_max=len(fit_columns[n])
-
+
for r in range(0,row_max):
tr = ET.SubElement(table,"tr")
- for c in range(0,columns):
- tdi = ET.SubElement(tr,"td")
+ for c in range(0,columns):
+ tdi = ET.SubElement(tr,"td")
tdi.attrib["align"]="right"
- td = ET.SubElement(tr,"td")
+ td = ET.SubElement(tr,"td")
if (r>=len(fit_columns[c])):
continue
-
+
classname = fit_columns[c][r]
print(classname)
if (classname in indexers):
-
+
span = ET.SubElement(tdi, "span")
span.attrib["class"] = "class_index_letter"
span.text = classname[:1].upper()
@@ -161,23 +161,23 @@ def make_html_class_list(class_list,columns):
csscc = ET.SubElement(cat_class_list, "link")
csscc.attrib["href"] = "main.css"
csscc.attrib["rel"] = "stylesheet"
- csscc.attrib["type"] = "text/css"
+ csscc.attrib["type"] = "text/css"
bodycc = ET.SubElement(cat_class_list, "body")
make_html_top(bodycc)
-
+
cat_class_parent=bodycc
else:
cat_class_parent=div
-
-
-
-
+
+
+
+
h1=ET.SubElement(cat_class_parent,"h2")
h1.text="Class List By Category"
-
+
class_cat_table={}
class_cat_list=[]
-
+
for c in class_list:
clss = classes[c]
if ("category" in clss.attrib):
@@ -190,9 +190,9 @@ def make_html_class_list(class_list,columns):
class_cat_list.append(class_cat)
class_cat_table[class_cat]=[]
class_cat_table[class_cat].append(c)
-
+
class_cat_list.sort()
-
+
ct = ET.SubElement(cat_class_parent,"table")
for cl in class_cat_list:
l = class_cat_table[cl]
@@ -201,7 +201,7 @@ def make_html_class_list(class_list,columns):
tr.attrib["class"]="category_title"
td = ET.SubElement(ct,"td")
td.attrib["class"]="category_title"
-
+
a = ET.SubElement(td,"a")
a.attrib["class"]="category_title"
a.text=cl
@@ -221,45 +221,45 @@ def make_html_class_list(class_list,columns):
bdtext=bd.text
td = ET.SubElement(ct,"td")
td.text=bdtext
-
+
if (not single_page):
- make_html_bottom(bodycc)
+ make_html_bottom(bodycc)
catet_out = ET.ElementTree(cat_class_list)
catet_out.write("category.html")
-
+
if (not single_page):
inh_class_list=ET.Element("html")
cssic = ET.SubElement(inh_class_list, "link")
cssic.attrib["href"] = "main.css"
cssic.attrib["rel"] = "stylesheet"
- cssic.attrib["type"] = "text/css"
+ cssic.attrib["type"] = "text/css"
bodyic = ET.SubElement(inh_class_list, "body")
make_html_top(bodyic)
inh_class_parent=bodyic
else:
inh_class_parent=div
-
-
-
-
+
+
+
+
h1=ET.SubElement(inh_class_parent,"h2")
h1.text="Class List By Inheritance"
-
+
itemlist = ET.SubElement(inh_class_parent,"list")
-
+
class_inh_table={}
def add_class(clss):
if (clss.attrib["name"] in class_inh_table):
return #already added
parent_list=None
-
+
if ("inherits" in clss.attrib):
inhc = clss.attrib["inherits"]
if (not (inhc in class_inh_table)):
add_class(classes[inhc])
-
+
parent_list = class_inh_table[inhc].find("div")
if (parent_list == None):
parent_div = ET.SubElement(class_inh_table[inhc],"div")
@@ -267,39 +267,39 @@ def make_html_class_list(class_list,columns):
parent_div.attrib["class"]="inh_class_list"
else:
parent_list = parent_list.find("list")
-
-
+
+
else:
parent_list=itemlist
-
+
item = ET.SubElement(parent_list,"li")
# item.attrib["class"]="inh_class_list"
- class_inh_table[clss.attrib["name"]]=item
+ class_inh_table[clss.attrib["name"]]=item
make_type(clss.attrib["name"],item)
-
-
- for c in class_list:
+
+
+ for c in class_list:
add_class(classes[c])
-
+
if (not single_page):
- make_html_bottom(bodyic)
+ make_html_bottom(bodyic)
catet_out = ET.ElementTree(inh_class_list)
catet_out.write("inheritance.html")
-
-
-
-
+
+
+
+
#h1=ET.SubElement(div,"h2")
#h1.text="Class List By Inheritance"
- return div
+ return div
def make_type(p_type,p_parent):
if (p_type=="RefPtr"):
p_type="Resource"
-
+
if (p_type in class_names):
a=ET.SubElement(p_parent,"a")
a.attrib["class"]="datatype_existing"
@@ -326,7 +326,7 @@ def make_text_def(class_name,parent,text):
endq_pos=text.find("]",pos+1)
if (endq_pos==-1):
break
-
+
pre_text=text[:pos]
post_text=text[endq_pos+1:]
tag_text=text[pos+1:endq_pos]
@@ -346,7 +346,7 @@ def make_text_def(class_name,parent,text):
elif(cmd.find("method")==0):
cmd=tag_text[:space_pos]
param=tag_text[space_pos+1:]
-
+
if (not single_page and param.find(".")!=-1):
class_param,method_param=param.split(".")
tag_text=tag_text='<a href="'+class_param+'.html#'+class_param+"_"+method_param+'">'+class_param+'.'+method_param+'()</a>'
@@ -358,22 +358,22 @@ def make_text_def(class_name,parent,text):
elif (cmd.find("url=")==0):
tag_text="<a href="+cmd[4:]+">"
elif (cmd=="/url"):
- tag_text="</a>"
+ tag_text="</a>"
elif (cmd=="center"):
- tag_text="<div align=\"center\">"
+ tag_text="<div align=\"center\">"
elif (cmd=="/center"):
tag_text="</div>"
elif (cmd=="br"):
- tag_text="<br/>"
+ tag_text="<br/>"
elif (cmd=="i" or cmd=="/i" or cmd=="b" or cmd=="/b" or cmd=="u" or cmd=="/u"):
tag_text="<"+tag_text+">" #html direct mapping
else:
tag_text="["+tag_text+"]"
-
-
+
+
text=pre_text+tag_text+post_text
pos=len(pre_text)+len(tag_text)
-
+
#tnode = ET.SubElement(parent,"div")
#tnode.text=text
text="<div class=\"description\">"+text+"</div>"
@@ -383,19 +383,19 @@ def make_text_def(class_name,parent,text):
except:
print("Error parsing description text: '"+text+"'")
sys.exit(255)
-
-
+
+
return tnode
-
-
+
+
def make_method_def(name,m,declare,event=False):
mdata={}
-
- if (not declare):
+
+ if (not declare):
div=ET.Element("tr")
div.attrib["class"]="method"
ret_parent=ET.SubElement(div,"td")
@@ -406,13 +406,13 @@ def make_method_def(name,m,declare,event=False):
div.attrib["class"]="method"
ret_parent=div
func_parent=div
-
+
mdata["argidx"]=[]
mdata["name"]=m.attrib["name"]
qualifiers=""
if ("qualifiers" in m.attrib):
qualifiers=m.attrib["qualifiers"]
-
+
args=list(m)
for a in args:
if (a.tag=="return"):
@@ -421,11 +421,11 @@ def make_method_def(name,m,declare,event=False):
idx=int(a.attrib["index"])
else:
continue
-
+
mdata["argidx"].append(idx)
mdata[idx]=a
- if (not event):
+ if (not event):
if (-1 in mdata["argidx"]):
make_type(mdata[-1].attrib["type"],ret_parent)
mdata["argidx"].remove(-1)
@@ -443,29 +443,29 @@ def make_method_def(name,m,declare,event=False):
a=ET.SubElement(span,"a")
a.attrib["href"]="#"+name+"_"+m.attrib["name"]
a.text=m.attrib["name"]
-
+
span=ET.SubElement(func_parent,"span")
span.attrib["class"]="symbol"
span.text=" ("
-
+
for a in mdata["argidx"]:
arg=mdata[a]
- if (a>0):
+ if (a>0):
span=ET.SubElement(func_parent,"span")
span.text=", "
else:
span=ET.SubElement(func_parent,"span")
span.text=" "
-
-
+
+
make_type(arg.attrib["type"],func_parent)
span=ET.SubElement(func_parent,"span")
span.text=arg.attrib["name"]
if ("default" in arg.attrib):
span.text=span.text+"="+arg.attrib["default"]
-
-
+
+
span=ET.SubElement(func_parent,"span")
span.attrib["class"]="symbol"
if (len(mdata["argidx"])):
@@ -477,9 +477,9 @@ def make_method_def(name,m,declare,event=False):
span=ET.SubElement(func_parent,"span")
span.attrib["class"]="qualifier"
span.text=" "+qualifiers
-
+
return div
-
+
def make_html_class(node):
@@ -488,7 +488,7 @@ def make_html_class(node):
a=ET.SubElement(div,"a")
a.attrib["name"]=node.attrib["name"]
-
+
h3=ET.SubElement(a,"h3")
h3.attrib["class"]="title class_title"
h3.text=node.attrib["name"]
@@ -498,63 +498,63 @@ def make_html_class(node):
div2=ET.SubElement(div,"div")
div2.attrib["class"]="description class_description"
div2.text=briefd.text
-
+
if ("inherits" in node.attrib):
ET.SubElement(div,"br")
- div2=ET.SubElement(div,"div")
+ div2=ET.SubElement(div,"div")
div2.attrib["class"]="inheritance";
span=ET.SubElement(div2,"span")
span.text="Inherits: "
-
+
make_type(node.attrib["inherits"],div2)
-
+
if ("category" in node.attrib):
ET.SubElement(div,"br")
-
- div3=ET.SubElement(div,"div")
+
+ div3=ET.SubElement(div,"div")
div3.attrib["class"]="category";
-
+
span=ET.SubElement(div3,"span")
span.attrib["class"]="category"
span.text="Category: "
-
+
a = ET.SubElement(div3,"a")
a.attrib["class"]="category_ref"
a.text=node.attrib["category"]
catname=a.text
if (catname.rfind("/")!=-1):
- catname=catname[catname.rfind("/"):]
+ catname=catname[catname.rfind("/"):]
catname="CATEGORY_"+catname
-
+
if (single_page):
a.attrib["href"]="#"+catname
else:
a.attrib["href"]="category.html#"+catname
-
-
- methods = node.find("methods")
-
+
+
+ methods = node.find("methods")
+
if(methods!=None and len(list(methods))>0):
h4=ET.SubElement(div,"h4")
h4.text="Public Methods:"
- method_table=ET.SubElement(div,"table")
+ method_table=ET.SubElement(div,"table")
method_table.attrib["class"]="method_list";
for m in list(methods):
# li = ET.SubElement(div2, "li")
method_table.append( make_method_def(node.attrib["name"],m,False) )
- events = node.find("signals")
-
+ events = node.find("signals")
+
if(events!=None and len(list(events))>0):
h4=ET.SubElement(div,"h4")
h4.text="Events:"
- event_table=ET.SubElement(div,"table")
+ event_table=ET.SubElement(div,"table")
event_table.attrib["class"]="method_list";
for m in list(events):
@@ -562,20 +562,20 @@ def make_html_class(node):
event_table.append( make_method_def(node.attrib["name"],m,False,True) )
- members = node.find("members")
+ members = node.find("members")
if(members!=None and len(list(members))>0):
h4=ET.SubElement(div,"h4")
h4.text="Public Variables:"
- div2=ET.SubElement(div,"div")
+ div2=ET.SubElement(div,"div")
div2.attrib["class"]="member_list";
-
+
for c in list(members):
-
+
li = ET.SubElement(div2, "li")
div3=ET.SubElement(li,"div")
div3.attrib["class"]="member";
- make_type(c.attrib["type"],div3)
+ make_type(c.attrib["type"],div3)
span=ET.SubElement(div3,"span")
span.attrib["class"]="identifier member_name"
span.text=" "+c.attrib["name"]+" "
@@ -584,19 +584,19 @@ def make_html_class(node):
span.text=c.text
- constants = node.find("constants")
+ constants = node.find("constants")
if(constants!=None and len(list(constants))>0):
h4=ET.SubElement(div,"h4")
h4.text="Constants:"
- div2=ET.SubElement(div,"div")
+ div2=ET.SubElement(div,"div")
div2.attrib["class"]="constant_list";
-
+
for c in list(constants):
li = ET.SubElement(div2, "li")
div3=ET.SubElement(li,"div")
div3.attrib["class"]="constant";
-
+
span=ET.SubElement(div3,"span")
span.attrib["class"]="identifier constant_name"
span.text=c.attrib["name"]+" "
@@ -610,22 +610,22 @@ def make_html_class(node):
span=ET.SubElement(div3,"span")
span.attrib["class"]="constant_description"
span.text=c.text
-
+
# ET.SubElement(div,"br")
-
-
+
+
descr=node.find("description")
if (descr!=None and descr.text.strip()!=""):
h4=ET.SubElement(div,"h4")
h4.text="Description:"
-
+
make_text_def(node.attrib["name"],div,descr.text)
-# div2=ET.SubElement(div,"div")
+# div2=ET.SubElement(div,"div")
# div2.attrib["class"]="description";
# div2.text=descr.text
-
-
-
+
+
+
if(methods!=None or events!=None):
h4=ET.SubElement(div,"h4")
@@ -639,7 +639,7 @@ def make_html_class(node):
for m in iter_list:
descr=m.find("description")
-
+
if (descr==None or descr.text.strip()==""):
continue;
@@ -651,11 +651,11 @@ def make_html_class(node):
#anchor = ET.SubElement(div2, "a")
#anchor.attrib["name"] =
make_text_def(node.attrib["name"],div2,descr.text)
- #div3=ET.SubElement(div2,"div")
+ #div3=ET.SubElement(div2,"div")
#div3.attrib["class"]="description";
#div3.text=descr.text
-
-
+
+
return div
class_names=[]
@@ -676,7 +676,7 @@ for file in input_list:
continue
class_names.append(c.attrib["name"])
classes[c.attrib["name"]]=c
-
+
html = ET.Element("html")
css = ET.SubElement(html, "link")
css.attrib["href"] = "main.css"
@@ -690,7 +690,7 @@ if (not single_page):
class_names.sort()
-
+
body.append( make_html_class_list(class_names,5) )
for cn in class_names:
@@ -704,9 +704,9 @@ for cn in class_names:
css.attrib["rel"] = "stylesheet"
css.attrib["type"] = "text/css"
body2 = ET.SubElement(html2, "body" )
- make_html_top(body2)
- body2.append( make_html_class(c) );
- make_html_bottom(body2)
+ make_html_top(body2)
+ body2.append( make_html_class(c) );
+ make_html_bottom(body2)
et_out = ET.ElementTree(html2)
et_out.write(c.attrib["name"]+".html")
diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py
index e012287b0e..38b493b0bf 100644
--- a/doc/tools/makemd.py
+++ b/doc/tools/makemd.py
@@ -54,7 +54,7 @@ def make_class_list(class_list, columns):
row_max = 0
f.write("\n")
-
+
for n in range(0, columns):
if len(fit_columns[n]) > row_max:
row_max = len(fit_columns[n])
@@ -63,7 +63,7 @@ def make_class_list(class_list, columns):
for n in range(0, columns):
f.write(" | |")
- f.write("\n")
+ f.write("\n")
f.write("| ")
for n in range(0, columns):
f.write(" --- | ------- |")
diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py
index 6311be767c..060dbc805d 100644
--- a/doc/tools/makerst.py
+++ b/doc/tools/makerst.py
@@ -60,7 +60,7 @@ def make_class_list(class_list, columns):
row_max = 0
f.write("\n")
-
+
for n in range(0, columns):
if len(fit_columns[n]) > row_max:
row_max = len(fit_columns[n])
@@ -69,7 +69,7 @@ def make_class_list(class_list, columns):
for n in range(0, columns):
f.write(" | |")
- f.write("\n")
+ f.write("\n")
f.write("+")
for n in range(0, columns):
f.write("--+-------+")
@@ -265,7 +265,7 @@ def make_method(
t = '- '
else:
t = ""
-
+
ret_type = 'void'
args = list(m)
mdata = {}
@@ -332,7 +332,7 @@ def make_method(
if (not declare):
if (pp!=None):
pp.append( (t,s) )
- else:
+ else:
f.write("- "+t+" "+s+"\n")
else:
f.write(t+s+"\n")
@@ -366,24 +366,24 @@ def make_rst_class(node):
f.write(" **<** ")
else:
first=False
-
+
f.write(make_type(inh))
inode = classes[inh]
if ('inherits' in inode.attrib):
inh=inode.attrib['inherits'].strip()
else:
inh=None
-
-
+
+
f.write("\n\n")
-
+
inherited=[]
for cn in classes:
- c=classes[cn]
+ c=classes[cn]
if 'inherits' in c.attrib:
if (c.attrib['inherits'].strip()==name):
inherited.append(c.attrib['name'])
-
+
if (len(inherited)):
f.write('**Inherited By:** ')
for i in range(len(inherited)):
@@ -415,7 +415,7 @@ def make_rst_class(node):
tl = len(s[1])
if (tl>longest_t):
longest_t=tl
-
+
sep="+"
for i in range(longest_s+2):
sep+="-"