c/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2 synced 2025-03-28 21:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Allow missing desc if we have a retdesc

Browse Source 
Allow missing function descriptions if the return value is documented.
This commit is contained in:
Nick Wellnhofer 2024-05-20 13:54:09 +02:00
parent b47a95fe31
commit a800e0035c
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/apibuild.py
View File

@ -905,7 +905,7 @@ class CParser:
i = i + 1 i = i + 1
if retdesc == "" and ret[0] != "void": if retdesc == "" and ret[0] != "void":
self.warning("Function comment for %s lacks description of return value" % (name)) self.warning("Function comment for %s lacks description of return value" % (name))
if desc == "": if desc == "" and retdesc == "":
self.warning("Function comment for %s lacks description of the function" % (name)) self.warning("Function comment for %s lacks description of the function" % (name))
return(((ret[0], retdesc), args, desc)) return(((ret[0], retdesc), args, desc))
@ -1774,7 +1774,8 @@ class docBuilder:
try: try:
(ret, params, desc) = id.info (ret, params, desc) = id.info
if (desc == None or desc == '') and \ if (desc == None or desc == '') and \
name[0:9] != "xmlThrDef" and name != "xmlDllMain": name[0:9] != "xmlThrDef" and name != "xmlDllMain" and \
ret[1] == '':
print("%s %s from %s has no description" % (id.type, name, print("%s %s from %s has no description" % (id.type, name,
self.modulename_file(id.module))) self.modulename_file(id.module)))