[libvirt] [PATCH 2/4] apibuild: Allow completely skipping certain macros
Some macros don't make sense to be documented at all. Add infrastructure
to the web/api generator and add VIR_DEPRECATED and VIR_EXPORT_VAR as
macros we should not document.
---
docs/apibuild.py | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/apibuild.py b/docs/apibuild.py
index f934fb2..9e63270 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -111,6 +111,12 @@ ignored_macros = {
"_virMemoryParameter": "backward compatibility macro for
virTypedParameter",
}
+# macros that should be completely skipped
+hidden_macros = {
+ "VIR_DEPRECATED", # internal macro to mark deprecated apis
+ "VIR_EXPORT_VAR", # internal macro to mark exported vars
+}
+
def escape(raw):
raw = string.replace(raw, '&', '&')
raw = string.replace(raw, '<', '<')
@@ -1034,6 +1040,11 @@ class CParser:
name = string.split(name, '(') [0]
except:
pass
+
+ # skip hidden macros
+ if name in hidden_macros:
+ return token
+
strValue = None
if len(lst) == 1 and lst[0][0] == '"' and lst[0][-1] ==
'"':
strValue = lst[0][1:-1]
--
2.8.1