very first version of the documentation checking script

2011-06-01 21:15:36 +00:00
parent 6c437cce36
commit 124967eefb
2 changed files with 174 additions and 23 deletions
--- a/doc/check_docs.py
+++ b/doc/check_docs.py
@@ -0,0 +1,108 @@
+import sys, glob
+
+sys.path.append("../modules/python/src2/")
+import hdr_parser as hp
+
+opencv_hdr_list = [
+"../modules/core/include/opencv2/core/core.hpp",
+"../modules/ml/include/opencv2/ml/ml.hpp",
+"../modules/imgproc/include/opencv2/imgproc/imgproc.hpp",
+"../modules/calib3d/include/opencv2/calib3d/calib3d.hpp",
+"../modules/features2d/include/opencv2/features2d/features2d.hpp",
+"../modules/video/include/opencv2/video/tracking.hpp",
+"../modules/video/include/opencv2/video/background_segm.hpp",
+"../modules/objdetect/include/opencv2/objdetect/objdetect.hpp",
+"../modules/highgui/include/opencv2/highgui/highgui.hpp",
+]
+
+opencv_module_list = [
+"core",
+"imgproc",
+"calib3d",
+"features2d",
+"video",
+"objdetect",
+"highgui",
+"ml"
+]
+
+class RSTParser(object):
+            
+    def process_rst(self, docname):
+        df = open(docname, "rt")
+        fdecl = ""
+        balance = 0
+        lineno = 0
+    
+        for l in df.readlines():
+            lineno += 1
+            ll = l.strip()
+            if balance == 0:
+                if not ll.startswith(".. c:function::") and not ll.startswith(".. cpp:function::"):
+                    continue
+                fdecl = ll[ll.find("::") + 3:]
+            elif balance > 0:
+                fdecl += ll
+            balance = fdecl.count("(") - fdecl.count(")")
+            assert balance >= 0
+            if balance > 0:
+                continue
+            rst_decl = self.parser.parse_func_decl_no_wrap(fdecl)
+            hdr_decls = self.fmap.get(rst_decl[0], [])
+            if not hdr_decls:
+                print "Documented function %s (%s) in %s:%d is not in the headers" % (fdecl, rst_decl[0], docname, lineno)
+                continue
+            decl_idx = 0
+            for hd in hdr_decls:
+                if len(hd[3]) != len(rst_decl[3]):
+                    continue
+                idx = 0
+                for a in hd[3]:
+                    if a[0] != rst_decl[3][idx][0]:
+                        break
+                    idx += 1
+                if idx == len(hd[3]):
+                    break
+                decl_idx += 1
+            if decl_idx < len(hdr_decls):
+                self.fmap[rst_decl[0]] = hdr_decls[:decl_idx] + hdr_decls[decl_idx+1:]
+                continue
+            print "Documented function %s in %s:%d does not have a match" % (fdecl, docname, lineno)
+
+    def check_module_docs(self, name):
+        self.parser = hp.CppHeaderParser()
+        decls = []
+        self.fmap = {}
+
+        for hname in opencv_hdr_list:
+            if hname.startswith("../modules/" + name):
+                decls += self.parser.parse(hname, wmode=False)
+                
+        #parser.print_decls(decls)
+    
+        for d in decls:
+            fname = d[0]
+            if not fname.startswith("struct") and not fname.startswith("class") and not fname.startswith("const"):
+                dlist = self.fmap.get(fname, [])
+                dlist.append(d)
+                self.fmap[fname] = dlist 
+    
+        self.missing_docfunc_list = []
+    
+        doclist = glob.glob("../modules/" + name + "/doc/*.rst")
+        for d in doclist:
+            self.process_rst(d)
+            
+        print "\n\n########## The list of undocumented functions: ###########\n\n"
+        fkeys = sorted(self.fmap.keys())
+        for f in fkeys:
+            decls = self.fmap[f]
+            for d in decls:
+                print "%s %s(%s)" % (d[1], d[0], ", ".join([a[0] + " " + a[1] for a in d[3]]))
+    
+p = RSTParser()
+for m in opencv_module_list:
+    print "\n\n*************************** " + m + " *************************\n"
+    p.check_module_docs(m)
+
+