summaryrefslogtreecommitdiff
path: root/scripts/lib/kdoc/kdoc_item.py
blob: b3b225764550dfe47200a5ad736d5e407d3ae0c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# SPDX-License-Identifier: GPL-2.0
#
# A class that will, eventually, encapsulate all of the parsed data that we
# then pass into the output modules.
#

class KdocItem:
    def __init__(self, name, type, start_line, **other_stuff):
        self.name = name
        self.type = type
        self.declaration_start_line = start_line
        self.sections = {}
        self.sections_start_lines = {}
        self.parameterlist = []
        self.parameterdesc_start_lines = []
        self.parameterdescs = {}
        self.parametertypes = {}
        #
        # Just save everything else into our own dict so that the output
        # side can grab it directly as before.  As we move things into more
        # structured data, this will, hopefully, fade away.
        #
        self.other_stuff = other_stuff

    def get(self, key, default = None):
        return self.other_stuff.get(key, default)

    def __getitem__(self, key):
        return self.get(key)

    #
    # Tracking of section and parameter information.
    #
    def set_sections(self, sections, start_lines):
        self.sections = sections
        self.section_start_lines = start_lines

    def set_params(self, names, descs, types, starts):
        self.parameterlist = names
        self.parameterdescs = descs
        self.parametertypes = types
        self.parameterdesc_start_lines = starts