summaryrefslogtreecommitdiff
path: root/docs/api.rst
blob: a9a0d16d969e16581f05df2450f7ecc46b4cebcf (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
===
API
===


Generator API
=============

.. inheritance-diagram:: qface.generator


Generator Class
---------------

.. module:: qface.generator

Provides an API for accessing the file system and controlling the generator


FileSystem Class
----------------

.. autoclass:: qface.generator.FileSystem
    :members:
    :show-inheritance:

.. autoclass:: qface.generator.Generator
    :members:
    :show-inheritance:


Template Domain API
===================

.. module:: qface.idl.domain

This API is exposed to the Jinja template system.

.. inheritance-diagram:: qface.idl.domain

High Level Classes
------------------

.. autoclass:: qface.idl.domain.System
    :members:
    :show-inheritance:

.. autoclass:: qface.idl.domain.Module
    :members:
    :show-inheritance:


Interface Related Classes
-------------------------

.. autoclass:: qface.idl.domain.Interface
    :members:
    :show-inheritance:


.. autoclass:: qface.idl.domain.Operation
    :members:
    :show-inheritance:

.. autoclass:: qface.idl.domain.Parameter
    :members:
    :show-inheritance:

.. autoclass:: qface.idl.domain.Property
    :members:
    :show-inheritance:


Struct Related Classes
----------------------

.. autoclass:: qface.idl.domain.Struct
    :members:
    :show-inheritance:


.. autoclass:: qface.idl.domain.Field
    :members:
    :show-inheritance:

.. rubric:: Enum/Flag Related Classes

.. autoclass:: qface.idl.domain.Enum
    :members:
    :show-inheritance:

.. autoclass:: qface.idl.domain.EnumMember
    :members:
    :show-inheritance:


Base Classes
------------

.. autoclass:: qface.idl.domain.NamedElement
    :members:
    :show-inheritance:

.. autoclass:: qface.idl.domain.Symbol
    :members:
    :show-inheritance:

.. autoclass:: qface.idl.domain.TypeSymbol
    :members:
    :show-inheritance:

Utility Modules
---------------

.. autofunction:: qface.watch.monitor

.. autofunction:: qface.shell.sh