[DEV] add html genertation instead of md file
This commit is contained in:
parent
50caa0371f
commit
1560981f6c
217
lutinDoc.py
217
lutinDoc.py
@ -5,217 +5,14 @@ import lutinTools
|
||||
# TODO : Add try of generic input ...
|
||||
sys.path.append(lutinTools.GetCurrentPath(__file__) + "/ply/ply/")
|
||||
sys.path.append(lutinTools.GetCurrentPath(__file__) + "/cppParser/CppheaderParser/")
|
||||
import CppHeaderParser
|
||||
|
||||
def writeExpendSize(data, size) :
|
||||
ret = data
|
||||
for iii in range(len(ret), size):
|
||||
ret += " "
|
||||
return ret
|
||||
|
||||
def displayReductFunction(function, file, classement, sizeReturn, sizefunction) :
|
||||
lineData = classement + " "
|
||||
|
||||
if function['destructor'] :
|
||||
lineData += writeExpendSize("", sizeReturn)
|
||||
lineData += "~"
|
||||
elif function['constructor'] :
|
||||
lineData += writeExpendSize("", sizeReturn+1)
|
||||
else :
|
||||
lineData += writeExpendSize(function["rtnType"], sizeReturn+1)
|
||||
|
||||
lineData += writeExpendSize(function["name"], sizefunction+1)
|
||||
lineData += "("
|
||||
file.write("\t" + lineData);
|
||||
parameterPos = len(lineData);
|
||||
isFirst = True
|
||||
for param in function["parameters"]:
|
||||
if isFirst == False:
|
||||
file.write(",\n\t")
|
||||
file.write(writeExpendSize("",parameterPos))
|
||||
file.write(param['type'])
|
||||
if param['name'] != "":
|
||||
file.write(" ")
|
||||
file.write(param['name'])
|
||||
isFirst = False
|
||||
file.write(");")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
def displayFunction(namespace, function, file, classement, sizeReturn, sizefunction) :
|
||||
lineData = ""
|
||||
if namespace != "":
|
||||
lineData = namespace + "::"
|
||||
if function['destructor'] :
|
||||
lineData += "~"
|
||||
lineData += function["name"] + "( ... )"
|
||||
file.write(lineData + "\n")
|
||||
for iii in range(0, len(lineData)):
|
||||
file.write(".")
|
||||
file.write("\n\n")
|
||||
|
||||
if function['destructor'] :
|
||||
lineData = "~"
|
||||
elif function['constructor'] :
|
||||
lineData = ""
|
||||
else :
|
||||
lineData = function["rtnType"] + " "
|
||||
|
||||
lineData += function["name"]
|
||||
lineData += "("
|
||||
file.write("\t" + lineData);
|
||||
parameterPos = len(lineData);
|
||||
isFirst = True
|
||||
for param in function["parameters"]:
|
||||
if isFirst == False:
|
||||
file.write(",\n\t")
|
||||
file.write(writeExpendSize("",parameterPos))
|
||||
file.write(param['type'])
|
||||
if param['name'] != "":
|
||||
file.write(" ")
|
||||
file.write(param['name'])
|
||||
isFirst = False
|
||||
file.write(");")
|
||||
file.write("\n\n")
|
||||
if "doxygen" in function:
|
||||
# TODO : parse doxygen ...
|
||||
file.write(function["doxygen"])
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
import lutinDocHtml
|
||||
import lutinDocMd
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
def calsulateSizeFunction(function, size) :
|
||||
if len(function["name"]) > size:
|
||||
return len(function["name"])+1
|
||||
return size
|
||||
|
||||
def calsulateSizeReturn(function, size) :
|
||||
if len(function["rtnType"]) > size:
|
||||
return len(function["rtnType"])+1
|
||||
return size
|
||||
|
||||
def GenerateDocFile(filename, outFolder) :
|
||||
try:
|
||||
metaData = CppHeaderParser.CppHeader(filename)
|
||||
except CppHeaderParser.CppParseError, e:
|
||||
debug.error(" can not parse the file: '" + filename + "' error : " + e)
|
||||
return False
|
||||
|
||||
lutinTools.CreateDirectoryOfFile(outFolder+"/");
|
||||
|
||||
for element in metaData.classes:
|
||||
classFileName = outFolder + "/"
|
||||
localClass = metaData.classes[element]
|
||||
if localClass['namespace'] == "":
|
||||
className = localClass['name']
|
||||
else:
|
||||
className = localClass['namespace'] + "::" + localClass['name']
|
||||
debug.debug(" class: " + className)
|
||||
classFileName += className
|
||||
# Replace all :: with __
|
||||
classFileName = classFileName.replace(":", "_")
|
||||
classFileName = classFileName.replace(" ", "")
|
||||
classFileName += ".md"
|
||||
file = open(classFileName, "w")
|
||||
|
||||
file.write(className + "\n")
|
||||
for iii in range(0,len(className)):
|
||||
file.write("=");
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
# calculate function max size return & function name size:
|
||||
sizeReturn=0
|
||||
sizefunction=0
|
||||
for function in localClass["methods"]["public"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
for function in localClass["methods"]["protected"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
for function in localClass["methods"]["private"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
|
||||
file.write("Synopsis:\n")
|
||||
file.write("---------\n")
|
||||
file.write("\n")
|
||||
# display all functions :
|
||||
# TODO: ...
|
||||
for function in localClass["methods"]["public"]:
|
||||
displayReductFunction(function, file, "public: ", sizeReturn, sizefunction)
|
||||
for function in localClass["methods"]["protected"]:
|
||||
displayReductFunction(function, file, "protected:", sizeReturn, sizefunction)
|
||||
for function in localClass["methods"]["private"]:
|
||||
displayReductFunction(function, file, "private: ", sizeReturn, sizefunction)
|
||||
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
if len(localClass['inherits']) != 0:
|
||||
file.write("Object Hierarchy:\n")
|
||||
file.write("-----------------\n")
|
||||
file.write("\n")
|
||||
for heritedClass in localClass['inherits']:
|
||||
file.write("\t" + heritedClass['class'] + "\n")
|
||||
file.write("\t |\n")
|
||||
file.write("\t +--> " + localClass['name'] + "\n")
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
"""
|
||||
file.write("Signals:\n")
|
||||
file.write("--------\n")
|
||||
file.write("\n")
|
||||
# display all signals :
|
||||
# TODO: ...
|
||||
|
||||
file.write("Configuration:\n")
|
||||
file.write("--------------\n")
|
||||
file.write("\n")
|
||||
# display all configuration :
|
||||
# TODO: ...
|
||||
"""
|
||||
|
||||
if "doxygen" in localClass:
|
||||
file.write("Description:\n")
|
||||
file.write("------------\n")
|
||||
file.write("\n")
|
||||
# display Class description :
|
||||
file.write(localClass["doxygen"])
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
file.write("Detail:\n")
|
||||
file.write("-------\n")
|
||||
file.write("\n")
|
||||
# display all the class internal functions :
|
||||
for function in localClass["methods"]["public"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "public: ", sizeReturn, sizefunction)
|
||||
file.write("\n________________________________________________________________________\n\n")
|
||||
for function in localClass["methods"]["protected"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "protected:", sizeReturn, sizefunction)
|
||||
file.write("\n________________________________________________________________________\n\n")
|
||||
for function in localClass["methods"]["private"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "private: ", sizeReturn, sizefunction)
|
||||
file.write("\n________________________________________________________________________\n\n")
|
||||
|
||||
|
||||
|
||||
if len(localClass['inherits']) != 0:
|
||||
for heritedClass in localClass['inherits']:
|
||||
debug.debug(" heritage : " + str(heritedClass['class']))
|
||||
|
||||
|
||||
file.close()
|
||||
|
||||
|
||||
"""
|
||||
|
||||
"""
|
||||
|
||||
def GenerateDocFile(filename, outFolder, isHtml=True) :
|
||||
if isHtml == True:
|
||||
lutinDocHtml.GenerateDocFile(filename, outFolder)
|
||||
else:
|
||||
lutinDocDot.GenerateDocFile(filename, outFolder)
|
||||
303
lutinDocHtml.py
Normal file
303
lutinDocHtml.py
Normal file
@ -0,0 +1,303 @@
|
||||
#!/usr/bin/python
|
||||
import lutinDebug as debug
|
||||
import sys
|
||||
import lutinTools
|
||||
# TODO : Add try of generic input ...
|
||||
sys.path.append(lutinTools.GetCurrentPath(__file__) + "/ply/ply/")
|
||||
sys.path.append(lutinTools.GetCurrentPath(__file__) + "/cppParser/CppheaderParser/")
|
||||
import CppHeaderParser
|
||||
import lutinDocHtml
|
||||
import lutinDocMd
|
||||
|
||||
def parse_doxygen(data) :
|
||||
pos = data.find("/*");
|
||||
if pos > 0:
|
||||
data = data[pos:]
|
||||
|
||||
if data[0] == '/' \
|
||||
and data[1] == '*' \
|
||||
and data[2] == '*':
|
||||
data = data[3:len(data)-2]
|
||||
data = data.replace("\n** ", "\n")
|
||||
data = data.replace("\n**", "\n")
|
||||
data = data.replace("\n* ", "\n")
|
||||
data = data.replace("\n*", "\n")
|
||||
data = data.replace("\n ** ", "\n")
|
||||
data = data.replace("\n **", "\n")
|
||||
data = data.replace("\n * ", "\n")
|
||||
data = data.replace("\n *", "\n")
|
||||
data = data.replace("\r", "")
|
||||
streams = data.split("@")
|
||||
data2 = ""
|
||||
for element in streams:
|
||||
if element[:1] == "\n" \
|
||||
or element[:2] == "\n\n":
|
||||
# nothing to do : Nomale case of the first \n
|
||||
None
|
||||
elif element[:6] == "brief ":
|
||||
data2 += element[6:]
|
||||
data2 += "<br/>"
|
||||
|
||||
for element in streams:
|
||||
if element[:1] == "\n" \
|
||||
or element[:2] == "\n\n":
|
||||
# nothing to do : Nomale case of the first \n
|
||||
None
|
||||
elif element[:5] == "note ":
|
||||
data2 += "<b>Notes:</b> "
|
||||
data2 += element[5:]
|
||||
data2 += "<br/> "
|
||||
|
||||
data3 = ""
|
||||
for element in streams:
|
||||
if element[:1] == "\n" \
|
||||
or element[:2] == "\n\n":
|
||||
# nothing to do : Nomale case of the first \n
|
||||
None
|
||||
elif element[:14] == "param[in,out] " \
|
||||
or element[:14] == "param[out,in] ":
|
||||
data3 += "<b>Parameter [input] [output]:</b> "
|
||||
data3 += element[14:]
|
||||
data3 += "<br/>"
|
||||
elif element[:10] == "param[in] ":
|
||||
data3 += "<b>Parameter [input]:</b> "
|
||||
data3 += element[10:]
|
||||
data3 += "<br/>"
|
||||
elif element[:11] == "param[out] ":
|
||||
data3 += "<b>Parameter [output]:</b> "
|
||||
data3 += element[11:]
|
||||
data3 += "<br/>"
|
||||
elif element[:6] == "param ":
|
||||
data3 += "<b>Parameter:</b> "
|
||||
data3 += element[6:]
|
||||
data3 += "<br/>"
|
||||
elif element[:7] == "return ":
|
||||
data3 += "<b>Return:</b> "
|
||||
data3 += element[7:]
|
||||
data3 += "<br/>"
|
||||
if data3 != "":
|
||||
data2 += "<ul>\n"
|
||||
data2 += data3
|
||||
data2 += "</ul>\n"
|
||||
return data2
|
||||
|
||||
|
||||
|
||||
def writeExpendSize(data, size) :
|
||||
ret = data
|
||||
for iii in range(len(ret), size):
|
||||
ret += " "
|
||||
return ret
|
||||
|
||||
def displayReductFunction(function, file, classement, sizeReturn, sizefunction) :
|
||||
lineData = classement + " "
|
||||
|
||||
if function['destructor'] :
|
||||
lineData += writeExpendSize("", sizeReturn)
|
||||
lineData += "~"
|
||||
elif function['constructor'] :
|
||||
lineData += writeExpendSize("", sizeReturn+1)
|
||||
else :
|
||||
lineData += writeExpendSize(function["rtnType"], sizeReturn+1)
|
||||
|
||||
lineData += writeExpendSize(function["name"], sizefunction+1)
|
||||
lineData += "("
|
||||
file.write(lineData);
|
||||
parameterPos = len(lineData);
|
||||
isFirst = True
|
||||
for param in function["parameters"]:
|
||||
if isFirst == False:
|
||||
file.write(",<br/>")
|
||||
file.write(writeExpendSize("",parameterPos))
|
||||
file.write(param['type'])
|
||||
if param['name'] != "":
|
||||
file.write(" ")
|
||||
file.write(param['name'])
|
||||
isFirst = False
|
||||
file.write(");")
|
||||
file.write("<br>")
|
||||
|
||||
|
||||
def displayFunction(namespace, function, file, classement, sizeReturn, sizefunction) :
|
||||
lineData = ""
|
||||
if ( function['constructor'] == True \
|
||||
or function['destructor'] == True \
|
||||
or function['static'] == True ) \
|
||||
and namespace != "":
|
||||
lineData = namespace + "::"
|
||||
if function['destructor'] :
|
||||
lineData += "~"
|
||||
lineData += function["name"] + "( ... )"
|
||||
file.write("<h3>" + lineData + "</h3>\n\n")
|
||||
|
||||
if function['destructor'] :
|
||||
lineData = "~"
|
||||
elif function['constructor'] :
|
||||
lineData = ""
|
||||
else :
|
||||
lineData = function["rtnType"] + " "
|
||||
|
||||
file.write("<pre>\n");
|
||||
lineData += function["name"]
|
||||
lineData += "("
|
||||
file.write(lineData);
|
||||
parameterPos = len(lineData);
|
||||
isFirst = True
|
||||
for param in function["parameters"]:
|
||||
if isFirst == False:
|
||||
file.write(",\n")
|
||||
file.write(writeExpendSize("", parameterPos))
|
||||
file.write(param['type'])
|
||||
if param['name'] != "":
|
||||
file.write(" ")
|
||||
file.write(param['name'])
|
||||
isFirst = False
|
||||
file.write(");")
|
||||
file.write("</pre>\n");
|
||||
file.write("<br/>\n")
|
||||
if "doxygen" in function:
|
||||
# TODO : parse doxygen ...
|
||||
file.write(parse_doxygen(function["doxygen"]))
|
||||
file.write("<br/>\n")
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
def calsulateSizeFunction(function, size) :
|
||||
if len(function["name"]) > size:
|
||||
return len(function["name"])+1
|
||||
return size
|
||||
|
||||
def calsulateSizeReturn(function, size) :
|
||||
if len(function["rtnType"]) > size:
|
||||
return len(function["rtnType"])+1
|
||||
return size
|
||||
|
||||
def add_header(file):
|
||||
file.write("<!DOCTYPE html>\n")
|
||||
file.write("<html>\n")
|
||||
file.write("<head>\n")
|
||||
file.write(" <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0\">\n")
|
||||
file.write(" <title>Ewol Library</title>\n")
|
||||
file.write(" <link rel=\"stylesheet\" href=\"base.css\">\n")
|
||||
file.write("</head>\n")
|
||||
file.write("<body>\n")
|
||||
file.write(" <div class=\"navbar navbar-fixed-top\">\n");
|
||||
file.write(" <div class=\"container\">\n")
|
||||
file.write(" Ewol Library\n")
|
||||
file.write(" </div>\n")
|
||||
file.write(" </div>\n")
|
||||
file.write(" <div class=\"container\" id=\"content\">\n")
|
||||
|
||||
def add_buttom(file):
|
||||
file.write(" </div>\n")
|
||||
file.write("</body>\n")
|
||||
file.write("</html>\n")
|
||||
|
||||
def GenerateDocFile(filename, outFolder) :
|
||||
try:
|
||||
metaData = CppHeaderParser.CppHeader(filename)
|
||||
except CppHeaderParser.CppParseError, e:
|
||||
debug.error(" can not parse the file: '" + filename + "' error : " + e)
|
||||
return False
|
||||
|
||||
lutinTools.CreateDirectoryOfFile(outFolder+"/");
|
||||
lutinTools.CopyFile(lutinTools.GetCurrentPath(__file__)+"/theme/base.css", outFolder+"/base.css")
|
||||
|
||||
for element in metaData.classes:
|
||||
classFileName = outFolder + "/"
|
||||
localClass = metaData.classes[element]
|
||||
if localClass['namespace'] == "":
|
||||
className = localClass['name']
|
||||
else:
|
||||
className = localClass['namespace'] + "::" + localClass['name']
|
||||
debug.debug(" class: " + className)
|
||||
classFileName += className
|
||||
# Replace all :: with __
|
||||
classFileName = classFileName.replace(":", "_")
|
||||
classFileName = classFileName.replace(" ", "")
|
||||
classFileName += ".html"
|
||||
file = open(classFileName, "w")
|
||||
|
||||
add_header(file)
|
||||
|
||||
file.write("<h1>" + className + "</h1>\n")
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
# calculate function max size return & function name size:
|
||||
sizeReturn=0
|
||||
sizefunction=0
|
||||
for function in localClass["methods"]["public"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
for function in localClass["methods"]["protected"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
for function in localClass["methods"]["private"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
|
||||
file.write("<h2>Synopsis:</h2>\n")
|
||||
# display all functions :
|
||||
# TODO: ...
|
||||
file.write("<pre>\n");
|
||||
for function in localClass["methods"]["public"]:
|
||||
displayReductFunction(function, file, "public: ", sizeReturn, sizefunction)
|
||||
for function in localClass["methods"]["protected"]:
|
||||
displayReductFunction(function, file, "protected:", sizeReturn, sizefunction)
|
||||
for function in localClass["methods"]["private"]:
|
||||
displayReductFunction(function, file, "private: ", sizeReturn, sizefunction)
|
||||
file.write("</pre>\n");
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
if len(localClass['inherits']) != 0:
|
||||
file.write("<h2>Object Hierarchy:</h2>\n")
|
||||
file.write("<pre>\n")
|
||||
for heritedClass in localClass['inherits']:
|
||||
file.write("" + heritedClass['class'] + "\n")
|
||||
file.write(" |\n")
|
||||
file.write(" +--> " + localClass['name'] + "\n")
|
||||
file.write("</pre>\n")
|
||||
file.write("<br/>\n")
|
||||
|
||||
|
||||
"""
|
||||
file.write("<h2>Signals:</h2>\n")
|
||||
# display all signals :
|
||||
# TODO: ...
|
||||
|
||||
file.write("<h2>Configuration:</h2>\n")
|
||||
# display all configuration :
|
||||
# TODO: ...
|
||||
"""
|
||||
|
||||
if "doxygen" in localClass:
|
||||
file.write("<h2>Description:</h2>\n")
|
||||
# display Class description :
|
||||
file.write(localClass["doxygen"])
|
||||
|
||||
|
||||
file.write("<h2>Detail:<h2>\n")
|
||||
# display all the class internal functions :
|
||||
for function in localClass["methods"]["public"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "public: ", sizeReturn, sizefunction)
|
||||
file.write("\n<hr/>\n")
|
||||
for function in localClass["methods"]["protected"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "protected:", sizeReturn, sizefunction)
|
||||
file.write("\n<hr/>\n")
|
||||
for function in localClass["methods"]["private"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "private: ", sizeReturn, sizefunction)
|
||||
file.write("\n<hr/>\n")
|
||||
|
||||
add_buttom(file)
|
||||
|
||||
file.close()
|
||||
|
||||
|
||||
"""
|
||||
|
||||
"""
|
||||
|
||||
278
lutinDocMd.py
Normal file
278
lutinDocMd.py
Normal file
@ -0,0 +1,278 @@
|
||||
#!/usr/bin/python
|
||||
import lutinDebug as debug
|
||||
import sys
|
||||
import lutinTools
|
||||
import CppHeaderParser
|
||||
|
||||
def parse_doxygen(data) :
|
||||
pos = data.find("/*");
|
||||
if pos > 0:
|
||||
data = data[pos:]
|
||||
|
||||
if data[0] == '/' \
|
||||
and data[1] == '*' \
|
||||
and data[2] == '*':
|
||||
data = data[3:len(data)-2]
|
||||
data = data.replace("\n** ", "\n")
|
||||
data = data.replace("\n**", "\n")
|
||||
data = data.replace("\n* ", "\n")
|
||||
data = data.replace("\n*", "\n")
|
||||
data = data.replace("\n ** ", "\n")
|
||||
data = data.replace("\n **", "\n")
|
||||
data = data.replace("\n * ", "\n")
|
||||
data = data.replace("\n *", "\n")
|
||||
data = data.replace("\r", "")
|
||||
streams = data.split("@")
|
||||
data2 = ""
|
||||
for element in streams:
|
||||
data2 += "\n"
|
||||
if element[:1] == "\n" \
|
||||
or element[:2] == "\n\n":
|
||||
# nothing to do : Nomale case of the first \n
|
||||
None
|
||||
elif element[:6] == "brief ":
|
||||
data2 += element[6:]
|
||||
data2 += "\n"
|
||||
elif element[:5] == "note ":
|
||||
data2 += "\t"
|
||||
data2 += "**Notes:** "
|
||||
data2 += element[5:]
|
||||
elif element[:14] == "param[in,out] " \
|
||||
or element[:14] == "param[out,in] ":
|
||||
data2 += "\t"
|
||||
data2 += "**Parameter [input] [output]:** "
|
||||
data2 += element[14:]
|
||||
elif element[:10] == "param[in] ":
|
||||
data2 += "\t"
|
||||
data2 += "**Parameter [input]:** "
|
||||
data2 += element[10:]
|
||||
elif element[:11] == "param[out] ":
|
||||
data2 += "\t"
|
||||
data2 += "**Parameter [output]:** "
|
||||
data2 += element[11:]
|
||||
elif element[:6] == "param ":
|
||||
data2 += "\t"
|
||||
data2 += "**Parameter:** "
|
||||
data2 += element[6:]
|
||||
elif element[:7] == "return ":
|
||||
data2 += "\t"
|
||||
data2 += "**Return:** "
|
||||
data2 += element[7:]
|
||||
else:
|
||||
data2 += "unknow : '" + element + "'"
|
||||
return data2
|
||||
|
||||
|
||||
|
||||
def writeExpendSize(data, size) :
|
||||
ret = data
|
||||
for iii in range(len(ret), size):
|
||||
ret += " "
|
||||
return ret
|
||||
|
||||
def displayReductFunction(function, file, classement, sizeReturn, sizefunction) :
|
||||
lineData = classement + " "
|
||||
|
||||
if function['destructor'] :
|
||||
lineData += writeExpendSize("", sizeReturn)
|
||||
lineData += "~"
|
||||
elif function['constructor'] :
|
||||
lineData += writeExpendSize("", sizeReturn+1)
|
||||
else :
|
||||
lineData += writeExpendSize(function["rtnType"], sizeReturn+1)
|
||||
|
||||
lineData += writeExpendSize(function["name"], sizefunction+1)
|
||||
lineData += "("
|
||||
file.write("\t" + lineData);
|
||||
parameterPos = len(lineData);
|
||||
isFirst = True
|
||||
for param in function["parameters"]:
|
||||
if isFirst == False:
|
||||
file.write(",\n\t")
|
||||
file.write(writeExpendSize("",parameterPos))
|
||||
file.write(param['type'])
|
||||
if param['name'] != "":
|
||||
file.write(" ")
|
||||
file.write(param['name'])
|
||||
isFirst = False
|
||||
file.write(");")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
def displayFunction(namespace, function, file, classement, sizeReturn, sizefunction) :
|
||||
lineData = ""
|
||||
if ( function['constructor'] == True \
|
||||
or function['destructor'] == True \
|
||||
or function['static'] == True ) \
|
||||
and namespace != "":
|
||||
lineData = namespace + "::"
|
||||
if function['destructor'] :
|
||||
lineData += "~"
|
||||
lineData += function["name"] + "( ... )"
|
||||
file.write("### " + lineData + "\n\n")
|
||||
|
||||
if function['destructor'] :
|
||||
lineData = "~"
|
||||
elif function['constructor'] :
|
||||
lineData = ""
|
||||
else :
|
||||
lineData = function["rtnType"] + " "
|
||||
|
||||
lineData += function["name"]
|
||||
lineData += "("
|
||||
file.write("\t" + lineData);
|
||||
parameterPos = len(lineData);
|
||||
isFirst = True
|
||||
for param in function["parameters"]:
|
||||
if isFirst == False:
|
||||
file.write(",\n\t")
|
||||
file.write(writeExpendSize("",parameterPos))
|
||||
file.write(param['type'])
|
||||
if param['name'] != "":
|
||||
file.write(" ")
|
||||
file.write(param['name'])
|
||||
isFirst = False
|
||||
file.write(");")
|
||||
file.write("\n\n")
|
||||
if "doxygen" in function:
|
||||
# TODO : parse doxygen ...
|
||||
file.write(parse_doxygen(function["doxygen"]))
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
def calsulateSizeFunction(function, size) :
|
||||
if len(function["name"]) > size:
|
||||
return len(function["name"])+1
|
||||
return size
|
||||
|
||||
def calsulateSizeReturn(function, size) :
|
||||
if len(function["rtnType"]) > size:
|
||||
return len(function["rtnType"])+1
|
||||
return size
|
||||
|
||||
def GenerateDocFile(filename, outFolder) :
|
||||
try:
|
||||
metaData = CppHeaderParser.CppHeader(filename)
|
||||
except CppHeaderParser.CppParseError, e:
|
||||
debug.error(" can not parse the file: '" + filename + "' error : " + e)
|
||||
return False
|
||||
|
||||
lutinTools.CreateDirectoryOfFile(outFolder+"/");
|
||||
|
||||
for element in metaData.classes:
|
||||
classFileName = outFolder + "/"
|
||||
localClass = metaData.classes[element]
|
||||
if localClass['namespace'] == "":
|
||||
className = localClass['name']
|
||||
else:
|
||||
className = localClass['namespace'] + "::" + localClass['name']
|
||||
debug.debug(" class: " + className)
|
||||
classFileName += className
|
||||
# Replace all :: with __
|
||||
classFileName = classFileName.replace(":", "_")
|
||||
classFileName = classFileName.replace(" ", "")
|
||||
classFileName += ".md"
|
||||
file = open(classFileName, "w")
|
||||
|
||||
file.write(className + "\n")
|
||||
for iii in range(0,len(className)):
|
||||
file.write("=");
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
# calculate function max size return & function name size:
|
||||
sizeReturn=0
|
||||
sizefunction=0
|
||||
for function in localClass["methods"]["public"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
for function in localClass["methods"]["protected"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
for function in localClass["methods"]["private"]:
|
||||
sizefunction = calsulateSizeFunction(function, sizefunction)
|
||||
sizeReturn = calsulateSizeReturn(function, sizeReturn)
|
||||
|
||||
file.write("Synopsis:\n")
|
||||
file.write("---------\n")
|
||||
file.write("\n")
|
||||
# display all functions :
|
||||
# TODO: ...
|
||||
for function in localClass["methods"]["public"]:
|
||||
displayReductFunction(function, file, "public: ", sizeReturn, sizefunction)
|
||||
for function in localClass["methods"]["protected"]:
|
||||
displayReductFunction(function, file, "protected:", sizeReturn, sizefunction)
|
||||
for function in localClass["methods"]["private"]:
|
||||
displayReductFunction(function, file, "private: ", sizeReturn, sizefunction)
|
||||
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
if len(localClass['inherits']) != 0:
|
||||
file.write("Object Hierarchy:\n")
|
||||
file.write("-----------------\n")
|
||||
file.write("\n")
|
||||
for heritedClass in localClass['inherits']:
|
||||
file.write("\t" + heritedClass['class'] + "\n")
|
||||
file.write("\t |\n")
|
||||
file.write("\t +--> " + localClass['name'] + "\n")
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
"""
|
||||
file.write("Signals:\n")
|
||||
file.write("--------\n")
|
||||
file.write("\n")
|
||||
# display all signals :
|
||||
# TODO: ...
|
||||
|
||||
file.write("Configuration:\n")
|
||||
file.write("--------------\n")
|
||||
file.write("\n")
|
||||
# display all configuration :
|
||||
# TODO: ...
|
||||
"""
|
||||
|
||||
if "doxygen" in localClass:
|
||||
file.write("Description:\n")
|
||||
file.write("------------\n")
|
||||
file.write("\n")
|
||||
# display Class description :
|
||||
file.write(localClass["doxygen"])
|
||||
file.write("\n")
|
||||
file.write("\n")
|
||||
|
||||
|
||||
file.write("Detail:\n")
|
||||
file.write("-------\n")
|
||||
file.write("\n")
|
||||
# display all the class internal functions :
|
||||
for function in localClass["methods"]["public"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "public: ", sizeReturn, sizefunction)
|
||||
file.write("\n________________________________________________________________________\n\n")
|
||||
for function in localClass["methods"]["protected"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "protected:", sizeReturn, sizefunction)
|
||||
file.write("\n________________________________________________________________________\n\n")
|
||||
for function in localClass["methods"]["private"]:
|
||||
displayFunction(localClass['namespace'] , function, file, "private: ", sizeReturn, sizefunction)
|
||||
file.write("\n________________________________________________________________________\n\n")
|
||||
|
||||
|
||||
|
||||
if len(localClass['inherits']) != 0:
|
||||
for heritedClass in localClass['inherits']:
|
||||
debug.debug(" heritage : " + str(heritedClass['class']))
|
||||
|
||||
|
||||
file.close()
|
||||
|
||||
|
||||
"""
|
||||
|
||||
"""
|
||||
|
||||
90
theme/base.css
Normal file
90
theme/base.css
Normal file
@ -0,0 +1,90 @@
|
||||
|
||||
html {
|
||||
display: block;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'Ubuntu',Tahoma,sans-serif;
|
||||
padding-top: 60px;
|
||||
padding-bottom: 40px;
|
||||
font-size: 15px;
|
||||
line-height: 150%;
|
||||
margin: 0;
|
||||
color: #333333;
|
||||
background-color: #ffffff;
|
||||
display: block;
|
||||
margin-left: 50px;
|
||||
margin-right: 50px;
|
||||
};
|
||||
|
||||
.container{
|
||||
width:940px;
|
||||
margin-right: auto;
|
||||
margin-left: auto;
|
||||
display: block;
|
||||
};
|
||||
|
||||
.navbar {
|
||||
z-index: 1;
|
||||
overflow: visible;
|
||||
color: #ffffff;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.navbar div {
|
||||
display: block;
|
||||
margin-left: 5px;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
.navbar-fixed-top {
|
||||
display: block;
|
||||
position: fixed;
|
||||
padding-top: 0px;
|
||||
top: 0;
|
||||
min-height: 40px;
|
||||
right: 0;
|
||||
left: 0;
|
||||
margin-bottom: 0;
|
||||
background-color: #d44413;
|
||||
border: 1px solid #c64012;
|
||||
font-size: 20px;
|
||||
font-weight: 200;
|
||||
color: #ffffff;
|
||||
text-shadow: 0 1px 0 #ce4213;
|
||||
padding: 10px 20px 10px;
|
||||
margin-left: -20px;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
display: block;
|
||||
margin: 10px 0;
|
||||
font-family: inherit;
|
||||
font-weight: bold;
|
||||
line-height: 1;
|
||||
color: inherit;
|
||||
text-rendering: optimizelegibility;
|
||||
}
|
||||
|
||||
p {
|
||||
margin: 0 0 10px;
|
||||
display: block;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin-left: 20px;
|
||||
display: block;
|
||||
padding: 9.5px;
|
||||
margin: 0 0 10px;
|
||||
font-size: 13px;
|
||||
line-height: 20px;
|
||||
word-break: break-all;
|
||||
word-wrap: break-word;
|
||||
white-space: pre;
|
||||
white-space: pre-wrap;
|
||||
background-color: #f5f5f5;
|
||||
border: 1px solid #ccc;
|
||||
border: 1px solid rgba(0, 0, 0, 0.15);
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user