Skip to content

robot.libdocpkg.model

LibraryDoc 

LibraryDoc(
    name="",
    doc="",
    version="",
    type="LIBRARY",
    scope="TEST",
    doc_format="ROBOT",
    source=None,
    lineno=-1,
)

Documentation for a library, a resource file or a suite file.

Source code in src/robot/libdocpkg/model.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
def __init__(self, name='', doc='', version='', type='LIBRARY', scope='TEST',
             doc_format='ROBOT', source=None, lineno=-1):
    self.name = name
    self._doc = doc
    self.version = version
    self.type = type
    self.scope = scope
    self.doc_format = doc_format
    self.source = source
    self.lineno = lineno
    self.inits = ()
    self.keywords = ()
    self.type_docs = ()

inits 

inits(inits)

Initializer docs as :class:~KeywordDoc instances.

Source code in src/robot/libdocpkg/model.py 
69
70
71
72
@setter
def inits(self, inits):
    """Initializer docs as :class:`~KeywordDoc` instances."""
    return self._process_keywords(inits)

keywords 

keywords(kws)

Keyword docs as :class:~KeywordDoc instances.

Source code in src/robot/libdocpkg/model.py 
74
75
76
77
@setter
def keywords(self, kws):
    """Keyword docs as :class:`~KeywordDoc` instances."""
    return self._process_keywords(kws)

KeywordDoc 

KeywordDoc(
    name="",
    args=None,
    doc="",
    short_doc="",
    tags=(),
    private=False,
    deprecated=False,
    source=None,
    lineno=-1,
    parent=None,
)

Bases: Sortable

Documentation for a single keyword or an initializer.

Source code in src/robot/libdocpkg/model.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
def __init__(self, name='', args=None, doc='', short_doc='', tags=(), private=False,
             deprecated=False, source=None, lineno=-1, parent=None):
    self.name = name
    self.args = args if args is not None else ArgumentSpec()
    self.doc = doc
    self._short_doc = short_doc
    self.tags = Tags(tags)
    self.private = private
    self.deprecated = deprecated
    self.source = source
    self.lineno = lineno
    self.parent = parent
    # Map argument types to type documentations.
    self.type_docs = {arg.name: {} for arg in self.args}