Skip to content

Commit 0d6556c

Browse files
committed
more doc updates
1 parent f814256 commit 0d6556c

File tree

11 files changed

+454
-216
lines changed

11 files changed

+454
-216
lines changed

docs/api/base.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,17 @@
33

44
.. automodule:: aaf.base
55

6+
AAFBase
7+
-------
8+
69
.. autoclass:: AAFBase
710
:members:
811
:undoc-members:
912
:show-inheritance:
1013

14+
AAFObject
15+
---------
16+
1117
.. autoclass:: AAFObject
1218
:members:
1319
:undoc-members:

docs/api/component.rst

Lines changed: 80 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,127 +3,153 @@
33

44
.. automodule:: aaf.component
55

6+
Component
7+
---------
8+
69
.. autoclass:: Component
710
:members:
8-
:undoc-members:
9-
:show-inheritance:
11+
12+
Segment
13+
-------
1014

1115
.. autoclass:: Segment
1216
:members:
13-
:undoc-members:
14-
:show-inheritance:
1517

18+
Transition
19+
----------
20+
1621
.. autoclass:: Transition
1722
:members:
18-
:undoc-members:
19-
:show-inheritance:
23+
24+
Sequence
25+
--------
2026

2127
.. autoclass:: Sequence
2228
:members:
23-
:undoc-members:
24-
:show-inheritance:
29+
30+
31+
Timecode
32+
--------
2533

2634
.. autoclass:: Timecode
2735
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
36+
37+
Filler
38+
------
39+
3140
.. autoclass:: Filler
3241
:members:
33-
:undoc-members:
34-
:show-inheritance:
42+
43+
Pulldown
44+
--------
3545

3646
.. autoclass:: Pulldown
3747
:members:
38-
:undoc-members:
39-
:show-inheritance:
48+
49+
SourceReference
50+
---------------
4051

4152
.. autoclass:: SourceReference
4253
:members:
43-
:undoc-members:
44-
:show-inheritance:
54+
55+
SourceClip
56+
----------
4557

4658
.. autoclass:: SourceClip
4759
:members:
48-
:undoc-members:
49-
:show-inheritance:
60+
61+
OperationGroup
62+
--------------
5063

5164
.. autoclass:: OperationGroup
5265
:members:
53-
:undoc-members:
54-
:show-inheritance:
5566

67+
NestedScope
68+
-----------
69+
5670
.. autoclass:: NestedScope
5771
:members:
58-
:undoc-members:
59-
:show-inheritance:
72+
73+
ScopeReference
74+
--------------
6075

6176
.. autoclass:: ScopeReference
6277
:members:
63-
:undoc-members:
64-
:show-inheritance:
78+
79+
EssenceGroup
80+
------------
6581

6682
.. autoclass:: EssenceGroup
6783
:members:
68-
:undoc-members:
69-
:show-inheritance:
84+
85+
Selector
86+
--------
7087

7188
.. autoclass:: Selector
7289
:members:
73-
:undoc-members:
74-
:show-inheritance:
90+
91+
EdgeCode
92+
--------
7593

7694
.. autoclass:: EdgeCode
7795
:members:
78-
:undoc-members:
79-
:show-inheritance:
80-
96+
97+
Event
98+
-----
99+
81100
.. autoclass:: Event
82101
:members:
83-
:undoc-members:
84-
:show-inheritance:
102+
103+
CommentMarker
104+
-------------
85105

86106
.. autoclass:: CommentMarker
87107
:members:
88-
:undoc-members:
89-
:show-inheritance:
90-
108+
109+
DescriptiveMarker
110+
-----------------
111+
91112
.. autoclass:: DescriptiveMarker
92113
:members:
93-
:undoc-members:
94-
:show-inheritance:
114+
115+
GPITrigger
116+
----------
95117

96118
.. autoclass:: GPITrigger
97119
:members:
98-
:undoc-members:
99-
:show-inheritance:
120+
121+
TimecodeStream
122+
--------------
100123

101124
.. autoclass:: TimecodeStream
102125
:members:
103-
:undoc-members:
104-
:show-inheritance:
126+
127+
TimecodeStream12M
128+
-----------------
105129

106130
.. autoclass:: TimecodeStream12M
107131
:members:
108-
:undoc-members:
109-
:show-inheritance:
110132

133+
Parameter
134+
---------
135+
111136
.. autoclass:: Parameter
112137
:members:
113-
:undoc-members:
114-
:show-inheritance:
138+
139+
ConstantValue
140+
-------------
115141

116142
.. autoclass:: ConstantValue
117143
:members:
118-
:undoc-members:
119-
:show-inheritance:
120-
144+
145+
VaryingValue
146+
------------
147+
121148
.. autoclass:: VaryingValue
122149
:members:
123-
:undoc-members:
124-
:show-inheritance:
150+
151+
ControlPoint
152+
------------
125153

126154
.. autoclass:: ControlPoint
127155
:members:
128-
:undoc-members:
129-
:show-inheritance:

0 commit comments

Comments
 (0)