Method deprecationComment

scripts/generator.py:598–631

If an API element is marked deprecated, return a brief comment describing why. Otherwise, return an empty string. - elem - Element of the API. API name is determined depending on the element tag. - indent - number of spaces to indent the comment

(self, elem, indent = 0)

        return False;

    def deprecationComment(self, elem, indent = 0):
        """If an API element is marked deprecated, return a brief comment
           describing why.
           Otherwise, return an empty string.

          - elem - Element of the API.
            API name is determined depending on the element tag.
          - indent - number of spaces to indent the comment"""

        reason = elem.get('deprecated')

        # This is almost always the path taken.
        if reason == None:
            return ''

        # There is actually a deprecated attribute.
        padding = indent * ' '

        # Determine the API name.
        if elem.tag == 'member' or elem.tag == 'param':
            name = elem.find('.//name').text
        else:
            name = elem.get('name')

        if reason == 'aliased':
            return f'{padding}// {name} is a legacy alias\n'
        elif reason == 'unused':
            return f'{padding}// {name} is legacy and not used\n'
        elif reason == 'true':
            return f'{padding}// {name} is legacy, but no reason was given in the API XML\n'
        else:
            # This can be caught by schema validation
            self.logMsg('error', f"{name} has an unknown legacy attribute value '{reason}'")
            exit(1)

    def buildEnumCDecl(self, expand, groupinfo, groupName):
        """Generate the C declaration for an enum"""