Skip to content

Commit 5ae1012

Browse files
zlovattzlovatt
committed
Some broad formatting changes
1 parent b2d724e commit 5ae1012

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2327
-2326
lines changed

‎docs/application/application.md‎

Lines changed: 151 additions & 149 deletions
Large diffs are not rendered by default.

‎docs/application/application.rst‎

Lines changed: 131 additions & 132 deletions
Large diffs are not rendered by default.

‎docs/collection/componentcollection.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
`app.project.sequences[index].videoTracks[index].clips[index].components.numItems`
2525
<br/>
2626

27-
**Description**
27+
#### Description
2828

2929
*add a description*
3030

31-
**Type**
31+
#### Type
3232

3333
Integer, read-only.

‎docs/collection/componentcollection.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ ComponentCollection.numItems
2929
| ``app.project.sequences[index].audioTracks[index].clips[index].components.numItems``
3030
| ``app.project.sequences[index].videoTracks[index].clips[index].components.numItems``
3131
32-
**Description**
32+
#### Description
3333

3434
*add a description*
3535

36-
**Type**
36+
#### Type
3737

3838
Integer, read-only.

‎docs/collection/markercollection.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ The MarkerCollection object represents a collection of [Marker objects](../gener
2020
`app.project.rootItem.children[index].getMarkers().numMarkers`
2121
<br/>
2222

23-
**Description**
23+
#### Description
2424

2525
The count of marker objects in the project item or sequence.
2626

27-
**Type**
27+
#### Type
2828

2929
Integer, read-only.
3030

@@ -39,17 +39,17 @@ Integer, read-only.
3939
`app.project.rootItem.children[index].getMarkers().createMarker(time)`
4040
<br/>
4141

42-
**Description**
42+
#### Description
4343

4444
Create a new [Marker object](../general/marker.md) on a project item or a sequence.
4545

46-
**Parameters**
46+
#### Parameters
4747

4848
| Argument | Type | Description |
4949
|------------|---------|-----------------------------------------------------|
50-
| `time` | `Float` | A time, in seconds, where marker should be created. |
50+
| `time` | Float | A time, in seconds, where marker should be created. |
5151

52-
**Returns**
52+
#### Returns
5353

5454
[Marker object](../general/marker.md) if successful.
5555

@@ -62,19 +62,19 @@ Create a new [Marker object](../general/marker.md) on a project item or a sequen
6262
`app.project.rootItem.children[index].getMarkers().deleteMarker(marker)`
6363
<br/>
6464

65-
**Description**
65+
#### Description
6666

6767
Remove a given marker object from a collection.
6868

69-
**Parameters**
69+
#### Parameters
7070

7171
| Argument | Type | Description |
7272
|------------|----------------------------------------------|--------------------------------------------|
7373
| `marker` | [Marker object](../general/marker.md) | A marker object to remove from collection. |
7474

75-
**Returns**
75+
#### Returns
7676

77-
`Boolean`.
77+
Boolean.
7878

7979
**Examples**
8080

@@ -102,15 +102,15 @@ alert('Removed ' + count.toString() + ' markers');
102102
`app.project.rootItem.children[index].getMarkers().getFirstMarker()`
103103
<br/>
104104

105-
**Description**
105+
#### Description
106106

107107
Retrieve the first marker object, sorted by time in seconds, on a given project item or sequence.
108108

109-
**Parameters**
109+
#### Parameters
110110

111111
None.
112112

113-
**Returns**
113+
#### Returns
114114

115115
[Marker object](../general/marker.md) or `undefined`.
116116

@@ -123,15 +123,15 @@ None.
123123
`app.project.rootItem.children[index].getMarkers().getLastMarker()`
124124
<br/>
125125

126-
**Description**
126+
#### Description
127127

128128
Retrieve the very last marker object, sorted by time in seconds, on a given project item or sequence.
129129

130-
**Parameters**
130+
#### Parameters
131131

132132
None.
133133

134-
**Returns**
134+
#### Returns
135135

136136
[Marker object](../general/marker.md) or `undefined`.
137137

@@ -144,17 +144,17 @@ None.
144144
`app.project.rootItem.children[index].getMarkers().getNextMarker(currentMarker)`
145145
<br/>
146146

147-
**Description**
147+
#### Description
148148

149149
Get the next available marker, sorted by seconds, starting from a given one.
150150

151-
**Parameters**
151+
#### Parameters
152152

153153
| Argument | Type | Description |
154154
|-----------------|----------------------------------------------|---------------------------------------------------------|
155155
| `currentMarker` | [Marker object](../general/marker.md) | A starting marker object, from which to get a next one. |
156156

157-
**Returns**
157+
#### Returns
158158

159159
[Marker object](../general/marker.md) or `undefined`.
160160

@@ -167,16 +167,16 @@ Get the next available marker, sorted by seconds, starting from a given one.
167167
`app.project.rootItem.children[index].getMarkers().getPrevMarker(currentMarker)`
168168
<br/>
169169

170-
**Description**
170+
#### Description
171171

172172
Get the previous available marker, sorted by seconds, starting from a given one.
173173

174-
**Parameters**
174+
#### Parameters
175175

176176
| Argument | Type | Description |
177177
|-----------------|----------------------------------------------|-------------------------------------------------------------|
178178
| `currentMarker` | [Marker object](../general/marker.md) | A starting marker object, from which to get a previous one. |
179179

180-
**Returns**
180+
#### Returns
181181

182182
[Marker object](../general/marker.md) or `undefined`.

‎docs/collection/markercollection.rst‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ MarkerCollection object
88
| ``app.project.sequences[index].markers``
99
| ``app.project.rootItem.children[index].getMarkers()``
1010
11-
The MarkerCollection object represents a collection of :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`.
11+
The MarkerCollection object represents a collection of :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`.
1212

1313
MarkerCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with MarkerCollection.
1414

@@ -26,11 +26,11 @@ MarkerCollection.numMarkers
2626
| ``app.project.sequences[index].markers.numMarkers``
2727
| ``app.project.rootItem.children[index].getMarkers().numMarkers``
2828
29-
**Description**
29+
#### Description
3030

3131
The count of marker objects in the project item or sequence.
3232

33-
**Type**
33+
#### Type
3434

3535
Integer, read-only.
3636

@@ -48,19 +48,19 @@ MarkerCollection.createMarker()
4848
| ``app.project.sequences[index].markers.createMarker(time)``
4949
| ``app.project.rootItem.children[index].getMarkers().createMarker(time)``
5050
51-
**Description**
51+
#### Description
5252

5353
Create a new :ref:`marker` on a project item or a sequence.
5454

55-
**Parameters**
55+
#### Parameters
5656

5757
================ =========== =======================
5858
Argument Type Description
5959
================ =========== =======================
60-
``time`` ``Float`` A time, in seconds, where marker should be created.
60+
``time`` `Float` A time, in seconds, where marker should be created.
6161
================ =========== =======================
6262

63-
**Returns**
63+
#### Returns
6464

6565
:ref:`marker` if successful.
6666

@@ -74,21 +74,21 @@ MarkerCollection.deleteMarker()
7474
| ``app.project.sequences[index].markers.deleteMarker(marker)``
7575
| ``app.project.rootItem.children[index].getMarkers().deleteMarker(marker)``
7676
77-
**Description**
77+
#### Description
7878

7979
Remove a given marker object from a collection.
8080

81-
**Parameters**
81+
#### Parameters
8282

8383
================ ============= =======================
8484
Argument Type Description
8585
================ ============= =======================
8686
``marker`` :ref:`marker` A marker object to remove from collection.
8787
================ ============= =======================
8888

89-
**Returns**
89+
#### Returns
9090

91-
``Boolean``.
91+
`Boolean`.
9292

9393
**Examples**
9494

@@ -117,15 +117,15 @@ MarkerCollection.getFirstMarker()
117117
| ``app.project.sequences[index].markers.getFirstMarker()``
118118
| ``app.project.rootItem.children[index].getMarkers().getFirstMarker()``
119119
120-
**Description**
120+
#### Description
121121

122122
Retrieve the first marker object, sorted by time in seconds, on a given project item or sequence.
123123

124-
**Parameters**
124+
#### Parameters
125125

126126
None.
127127

128-
**Returns**
128+
#### Returns
129129

130130
:ref:`marker` or ``undefined``.
131131

@@ -139,15 +139,15 @@ MarkerCollection.getLastMarker()
139139
| ``app.project.sequences[index].markers.getLastMarker()``
140140
| ``app.project.rootItem.children[index].getMarkers().getLastMarker()``
141141
142-
**Description**
142+
#### Description
143143

144144
Retrieve the very last marker object, sorted by time in seconds, on a given project item or sequence.
145145

146-
**Parameters**
146+
#### Parameters
147147

148148
None.
149149

150-
**Returns**
150+
#### Returns
151151

152152
:ref:`marker` or ``undefined``.
153153

@@ -161,19 +161,19 @@ MarkerCollection.getNextMarker()
161161
| ``app.project.sequences[index].markers.getNextMarker(currentMarker)``
162162
| ``app.project.rootItem.children[index].getMarkers().getNextMarker(currentMarker)``
163163
164-
**Description**
164+
#### Description
165165

166166
Get the next available marker, sorted by seconds, starting from a given one.
167167

168-
**Parameters**
168+
#### Parameters
169169

170170
================== ============= =======================
171171
Argument Type Description
172172
================== ============= =======================
173173
``currentMarker`` :ref:`marker` A starting marker object, from which to get a next one.
174174
================== ============= =======================
175175

176-
**Returns**
176+
#### Returns
177177

178178
:ref:`marker` or ``undefined``.
179179

@@ -187,18 +187,18 @@ MarkerCollection.getPrevMarker()
187187
| ``app.project.sequences[index].markers.getPrevMarker(currentMarker)``
188188
| ``app.project.rootItem.children[index].getMarkers().getPrevMarker(currentMarker)``
189189
190-
**Description**
190+
#### Description
191191

192192
Get the previous available marker, sorted by seconds, starting from a given one.
193193

194-
**Parameters**
194+
#### Parameters
195195

196196
================== ============= =======================
197197
Argument Type Description
198198
================== ============= =======================
199199
``currentMarker`` :ref:`marker` A starting marker object, from which to get a previous one.
200200
================== ============= =======================
201201

202-
**Returns**
202+
#### Returns
203203

204204
:ref:`marker` or ``undefined``.

‎docs/collection/projectcollection.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ The ProjectCollection object represents a collection of [Project objects](../gen
2020
`app.production.projects.numProjects`
2121
<br/>
2222

23-
**Description**
23+
#### Description
2424

2525
The total number of projects and productions found in the Project panel.
2626

27-
**Type**
27+
#### Type
2828

2929
Integer, read-only.

‎docs/collection/projectcollection.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ProjectCollection object
88
| ``app.projects``
99
| ``app.production.projects``
1010
11-
The ProjectCollection object represents a collection of :ref:`Project objects <project>`.
11+
The ProjectCollection object represents a collection of :ref:`Project objects <project>`.
1212

1313
ProjectCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectCollection.
1414

@@ -26,10 +26,10 @@ ProjectCollection.numProjects
2626
| ``app.projects.numProjects``
2727
| ``app.production.projects.numProjects``
2828
29-
**Description**
29+
#### Description
3030

3131
The total number of projects and productions found in the Project panel.
3232

33-
**Type**
33+
#### Type
3434

3535
Integer, read-only.

‎docs/collection/projectitemcollection.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ The ProjectItemCollection object represents a collection of [ProjectItem objects
1414

1515
`app.project.rootItem.children.numItems`
1616

17-
**Description**
17+
#### Description
1818

1919
The total number of items in the active project.
2020

21-
**Type**
21+
#### Type
2222

2323
Integer, read-only.

‎docs/collection/projectitemcollection.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ProjectItemCollection object
77

88
``app.project.rootItem.children``
99

10-
The ProjectItemCollection object represents a collection of :ref:`ProjectItem objects <projectItem>` in an active project.
10+
The ProjectItemCollection object represents a collection of :ref:`ProjectItem objects <projectItem>` in an active project.
1111

1212
ProjectItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectItemCollection.
1313

@@ -24,10 +24,10 @@ ProjectItemCollection.numItems
2424

2525
``app.project.rootItem.children.numItems``
2626

27-
**Description**
27+
#### Description
2828

2929
The total number of items in the active project.
3030

31-
**Type**
31+
#### Type
3232

3333
Integer, read-only.

0 commit comments

Comments
 (0)