From: Peter Krempa <pkrempa@redhat.com>
Date: Thu, 21 Apr 2016 12:31:23 +0000 (+0200)
Subject: apibuild: Allow completely skipping certain macros
X-Git-Tag: v1.3.4-rc1~83
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a253396a474d0b35d6c8ca7e40bf55a1e3450390;p=thirdparty%2Flibvirt.git

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.
---

diff --git a/docs/apibuild.py b/docs/apibuild.py
index f934fb20e9..9e63270f1f 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, '&', '&amp;')
     raw = string.replace(raw, '<', '&lt;')
@@ -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]