aboutsummaryrefslogtreecommitdiff
path: root/scripts/gen_api_vimdoc.py
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-12-11 02:12:05 +0100
committerGitHub <noreply@github.com>2017-12-11 02:12:05 +0100
commit8813b29cec13f7410427fbb8913d3753dd6626a7 (patch)
treefafa09d2333cfb51ec38e07b5cf11f21163583d3 /scripts/gen_api_vimdoc.py
parent6f41ce026005dab1129685f31bce9b85e62fd41f (diff)
parent23fb833ea75107a3349dfb0be2eeccc06111399c (diff)
downloadrneovim-8813b29cec13f7410427fbb8913d3753dd6626a7.tar.gz
rneovim-8813b29cec13f7410427fbb8913d3753dd6626a7.tar.bz2
rneovim-8813b29cec13f7410427fbb8913d3753dd6626a7.zip
Merge #7555 'vim-patch.sh, doc updates'
Diffstat (limited to 'scripts/gen_api_vimdoc.py')
-rw-r--r--scripts/gen_api_vimdoc.py17
1 files changed, 9 insertions, 8 deletions
diff --git a/scripts/gen_api_vimdoc.py b/scripts/gen_api_vimdoc.py
index 51e585a007..4ddf415f1a 100644
--- a/scripts/gen_api_vimdoc.py
+++ b/scripts/gen_api_vimdoc.py
@@ -45,6 +45,8 @@ if sys.version_info[0] < 3:
doc_filename = 'api.txt'
# String used to find the start of the generated part of the doc.
section_start_token = '*api-global*'
+# Required prefix for API function names.
+api_func_name_prefix = 'nvim_'
# Section name overrides.
section_name = {
@@ -260,11 +262,11 @@ def parse_parblock(parent, width=62):
def parse_source_xml(filename):
"""Collects API functions.
- This returns two strings:
- 1. The API functions
- 2. The deprecated API functions
+ Returns two strings:
+ 1. API functions
+ 2. Deprecated API functions
- The caller decides what to do with the deprecated documentation.
+ Caller decides what to do with the deprecated documentation.
"""
global xrefs
xrefs = set()
@@ -294,9 +296,8 @@ def parse_source_xml(filename):
annotations = get_text(get_child(member, 'argsstring'))
if annotations and ')' in annotations:
annotations = annotations.rsplit(')', 1)[-1].strip()
- # XXX: (doxygen 1.8.11) 'argsstring' only includes FUNC_ATTR_*
- # attributes if the function signature is non-void.
- # Force attributes here for such functions.
+ # XXX: (doxygen 1.8.11) 'argsstring' only includes attributes of
+ # non-void functions. Special-case void functions here.
if name == 'nvim_get_mode' and len(annotations) == 0:
annotations += 'FUNC_API_ASYNC'
annotations = filter(None, map(lambda x: annotation_map.get(x),
@@ -379,7 +380,7 @@ def parse_source_xml(filename):
if 'Deprecated' in xrefs:
deprecated_functions.append(func_doc)
- else:
+ elif name.startswith(api_func_name_prefix):
functions.append(func_doc)
xrefs.clear()