Procházet zdrojové kódy

add: 代码补全加上其他信息

chenxuuu před 3 roky
rodič
revize
9d102b477b
2 změnil soubory, kde provedl 16 přidání a 1 odebrání
  1. 1 1
      tools/documentGenerator.py
  2. 15 0
      tools/make_doc_file.py

+ 1 - 1
tools/documentGenerator.py

@@ -48,7 +48,7 @@ for module in modules:
             body = body[0:-1]+")"
         snippet[api_str] = {
             'body': body,
-            'description': api["summary"],
+            'description': make_doc_file.get_description(api),
             'prefix': api_str,
         }
 s = io.open(snippet_path,"w")

+ 15 - 0
tools/make_doc_file.py

@@ -55,3 +55,18 @@ def make(path,modules,index_text):
         mdoc.close()
 
     doc.close()
+
+
+def get_description(api):
+    s = api["api"]+" - "+api["summary"]+"\n"
+    if len(api["args"]) > 0:
+        s = s + "传入值:\n"
+        for arg in api["args"]:
+            s  = s + arg["type"] + " " + arg["summary"]+"\n"
+    if len(api["return"]) > 0:
+        s = s + "返回值:\n"
+        for arg in api["return"]:
+            s  = s + arg["type"] + " " + arg["summary"]+"\n"
+    if len(api["usage"]) > 0:
+        s = s + "例子:\n" + api["usage"]
+    return s