[vlc-commits] basic doc for constness in Par

[Alberto Invernizzi]

vlc/python | branch: master | Alberto Invernizzi <alby.inve at gmail.com> | Tue Mar 31 19:22:01 2020 +0200| [c312a87e7eac77964d879faae60dbdf10f67a638] | committer: Alberto Invernizzi

basic doc for constness in Par

> http://git.videolan.org/gitweb.cgi/vlc/python.git/?a=commit;h=c312a87e7eac77964d879faae60dbdf10f67a638
---

 generator/generate.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/generator/generate.py b/generator/generate.py
index 031f5e7..b0c2f2c 100755
--- a/generator/generate.py
+++ b/generator/generate.py
@@ -390,6 +390,14 @@ class Par(object):
     """C function parameter.
     """
     def __init__(self, name, type, constness):
+        """
+        constness:  a list of bools where each index refers to the constness
+                    of that level of indirection.
+                        [0] no indirection: is the value const?
+                        [1] pointer to value: is this pointer const?
+                        [2] pointer to pointer: is this pointer const?
+                        ... rare to see more than two levels of indirection
+        """
         self.name = name
         self.type = type  # C type
         self.constness = constness