Skip to content

Commit f9a9e88

Browse files
committed
Updated docs
1 parent b22a44f commit f9a9e88

File tree

10 files changed

+156
-158
lines changed

10 files changed

+156
-158
lines changed

Sources/SwiftTimecode/Documentation.docc/Documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ``swift-timecode``
1+
# ``SwiftTimecode``
22

33
Umbrella module that imports the entire swift-timecode library. Contains a Getting Started guide.
44

-335 KB
Loading

Sources/SwiftTimecodeCore/Documentation.docc/Timecode-Components.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ Primitive storage type for timecode component values.
2525

2626
### Array
2727

28-
- ``init(_:)-8i9vr``
28+
- ``init(_:)-63n08``
2929
- ``array``
3030

3131
### Dictionary
3232

33-
- ``init(_:)-7z48q``
33+
- ``init(_:)-38swh``
3434
- ``dictionary``
3535

3636
### Validation

Sources/SwiftTimecodeCore/Documentation.docc/Timecode-Constructors.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,39 @@
44

55
### Source Value
66

7-
- ``Timecode/init(_:using:)-7x46s``
8-
- ``Timecode/init(_:using:by:)-19laj``
9-
- ``Timecode/init(_:at:base:limit:)-6eprh``
10-
- ``Timecode/init(_:at:base:limit:by:)-7daaz``
7+
- ``Timecode/init(_:using:)-(TimecodeSourceValue,_)``
8+
- ``Timecode/init(_:using:by:)-(TimecodeSourceValue,_,_)``
9+
- ``Timecode/init(_:at:base:limit:)-(TimecodeSourceValue,_,_,_)``
10+
- ``Timecode/init(_:at:base:limit:by:)-(TimecodeSourceValue,_,_,_,_)``
1111

1212
### Async Source Value
1313

14-
- ``Timecode/init(_:using:)-2obvr``
15-
- ``Timecode/init(_:using:by:)-978c3``
16-
- ``Timecode/init(_:at:base:limit:)-45ucr``
17-
- ``Timecode/init(_:at:base:limit:by:)-7k12n``
14+
- ``Timecode/init(_:using:)-(AsyncTimecodeSourceValue,_)``
15+
- ``Timecode/init(_:using:by:)-(AsyncTimecodeSourceValue,_,_)``
16+
- ``Timecode/init(_:at:base:limit:)-(AsyncTimecodeSourceValue,_,_,_)``
17+
- ``Timecode/init(_:at:base:limit:by:)-(AsyncTimecodeSourceValue,_,_,_,_)``
1818

1919
### Guaranteed Source Value
2020

21-
- ``Timecode/init(_:using:)-5hu6e``
22-
- ``Timecode/init(_:at:base:limit:)-dux2``
21+
- ``Timecode/init(_:using:)-(GuaranteedTimecodeSourceValue,_)``
22+
- ``Timecode/init(_:at:base:limit:)-(GuaranteedTimecodeSourceValue,_,_,_)``
2323

2424
### Rich Source Value
2525

26-
- ``Timecode/init(_:)-60nf9``
27-
- ``Timecode/init(_:by:)``
26+
- ``Timecode/init(_:)-(RichTimecodeSourceValue)``
27+
- ``Timecode/init(_:by:)-(RichTimecodeSourceValue,_)``
2828

2929
### Async Rich Source Value
3030

31-
- ``Timecode/init(_:)-w15o``
31+
- ``Timecode/init(_:)-(AsyncRichTimecodeSourceValue)``
3232

3333
### Guaranteed Rich Source Value
3434

35-
- ``Timecode/init(_:)-5xi0q``
35+
- ``Timecode/init(_:)-(GuaranteedRichTimecodeSourceValue)``
3636

3737
### Formatted Source Value
3838

39-
- ``Timecode/init(_:using:)-2fc6x``
40-
- ``Timecode/init(_:using:by:)-xil6``
41-
- ``Timecode/init(_:at:base:limit:)-6vxuh``
42-
- ``Timecode/init(_:at:base:limit:by:)-7p0j2``
39+
- ``Timecode/init(_:using:)-(FormattedTimecodeSourceValue,_)``
40+
- ``Timecode/init(_:using:by:)-(FormattedTimecodeSourceValue,_,_)``
41+
- ``Timecode/init(_:at:base:limit:)-(FormattedTimecodeSourceValue,_,_,_)``
42+
- ``Timecode/init(_:at:base:limit:by:)-(FormattedTimecodeSourceValue,_,_,_,_)``

Sources/SwiftTimecodeCore/Documentation.docc/Timecode-Encoding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,8 @@ func validate(pastedTimecode: Timecode) {
192192

193193
### NSItemProvider
194194

195-
- ``Timecode/init(from:propertiesForString:)-7hl9l``
196-
- ``Timecode/init(from:propertiesForString:)-1cqhu``
195+
- ``Timecode/init(from:propertiesForString:)-(NSItemProvider,_)``
196+
- ``Timecode/init(from:propertiesForString:)-([NSItemProvider],_)``
197197
- ``Timecode/itemProviders(stringFormat:)``
198198

199199
### Transferable

Sources/SwiftTimecodeCore/Documentation.docc/Timecode-Math.md

Lines changed: 75 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -8,115 +8,115 @@ See the <doc:Math> article for a guide on using math methods.
88

99
### Addition
1010

11-
- ``Timecode/add(_:)-35dhi``
12-
- ``Timecode/add(_:by:)-1z454``
11+
- ``Timecode/add(_:)-(Timecode)``
12+
- ``Timecode/add(_:by:)-(Timecode,_)``
1313

14-
- ``Timecode/add(_:)-915h3``
15-
- ``Timecode/add(_:by:)-1m7ah``
14+
- ``Timecode/add(_:)-(Timecode.Components)``
15+
- ``Timecode/add(_:by:)-(Timecode.Components,_)``
1616

17-
- ``Timecode/add(_:)-9ru9i``
18-
- ``Timecode/add(_:by:)-7ca02``
17+
- ``Timecode/add(_:)-(TimecodeSourceValue)``
18+
- ``Timecode/add(_:by:)-(TimecodeSourceValue,_)``
1919

20-
- ``Timecode/add(_:)-7n3x6``
21-
- ``Timecode/add(_:by:)-5163j``
20+
- ``Timecode/add(_:)-(AsyncTimecodeSourceValue)``
21+
- ``Timecode/add(_:by:)-(AsyncTimecodeSourceValue,_)``
2222

23-
- ``Timecode/add(_:)-1i0b6``
24-
- ``Timecode/add(_:by:)-80c69``
23+
- ``Timecode/add(_:)-(GuaranteedTimecodeSourceValue)``
24+
- ``Timecode/add(_:by:)-(GuaranteedTimecodeSourceValue,_)``
2525

26-
- ``Timecode/add(_:)-5011j``
27-
- ``Timecode/add(_:by:)-7wdo4``
26+
- ``Timecode/add(_:)-(RichTimecodeSourceValue)``
27+
- ``Timecode/add(_:by:)-(RichTimecodeSourceValue,_)``
2828

29-
- ``Timecode/add(_:)-780aj``
30-
- ``Timecode/add(_:by:)-1xjog``
29+
- ``Timecode/add(_:)-(AsyncRichTimecodeSourceValue)``
30+
- ``Timecode/add(_:by:)-(AsyncRichTimecodeSourceValue,_)``
3131

32-
- ``Timecode/add(_:)-2v36p``
33-
- ``Timecode/add(_:by:)-3055l``
32+
- ``Timecode/add(_:)-(GuaranteedRichTimecodeSourceValue)``
33+
- ``Timecode/add(_:by:)-(GuaranteedRichTimecodeSourceValue,_)``
3434

35-
- ``Timecode/add(_:)-8mprr``
36-
- ``Timecode/add(_:by:)-34zg6``
35+
- ``Timecode/add(_:)-(FormattedTimecodeSourceValue)``
36+
- ``Timecode/add(_:by:)-(FormattedTimecodeSourceValue,_)``
3737

38-
- ``Timecode/adding(_:)-972mh``
39-
- ``Timecode/adding(_:by:)-2fl7h``
38+
- ``Timecode/adding(_:)-(Timecode)``
39+
- ``Timecode/adding(_:by:)-(Timecode,_)``
4040

41-
- ``Timecode/adding(_:)-1n8w6``
42-
- ``Timecode/adding(_:by:)-1op0e``
41+
- ``Timecode/adding(_:)-(Timecode.Components)``
42+
- ``Timecode/adding(_:by:)-(Timecode.Components,_)``
4343

44-
- ``Timecode/adding(_:)-64k1i``
45-
- ``Timecode/adding(_:by:)-8egjm``
44+
- ``Timecode/adding(_:)-(TimecodeSourceValue)``
45+
- ``Timecode/adding(_:by:)-(TimecodeSourceValue,_)``
4646

47-
- ``Timecode/adding(_:)-19qjo``
48-
- ``Timecode/adding(_:by:)-73bh6``
47+
- ``Timecode/adding(_:)-(AsyncTimecodeSourceValue)``
48+
- ``Timecode/adding(_:by:)-(AsyncTimecodeSourceValue,_)``
4949

50-
- ``Timecode/adding(_:)-1wwhe``
51-
- ``Timecode/adding(_:by:)-9wvjs``
50+
- ``Timecode/adding(_:)-(GuaranteedTimecodeSourceValue)``
51+
- ``Timecode/adding(_:by:)-(GuaranteedTimecodeSourceValue,_)``
5252

53-
- ``Timecode/adding(_:)-29yhq``
54-
- ``Timecode/adding(_:by:)-7j36``
53+
- ``Timecode/adding(_:)-(RichTimecodeSourceValue)``
54+
- ``Timecode/adding(_:by:)-(RichTimecodeSourceValue,_)``
5555

56-
- ``Timecode/adding(_:)-29yto``
57-
- ``Timecode/adding(_:by:)-27jkt``
56+
- ``Timecode/adding(_:)-(AsyncRichTimecodeSourceValue)``
57+
- ``Timecode/adding(_:by:)-(AsyncRichTimecodeSourceValue,_)``
5858

59-
- ``Timecode/adding(_:)-462rx``
60-
- ``Timecode/adding(_:by:)-93tmz``
59+
- ``Timecode/adding(_:)-(GuaranteedRichTimecodeSourceValue)``
60+
- ``Timecode/adding(_:by:)-(GuaranteedRichTimecodeSourceValue,_)``
6161

62-
- ``Timecode/adding(_:)-5xq6h``
63-
- ``Timecode/adding(_:by:)-9w4iw``
62+
- ``Timecode/adding(_:)-(FormattedTimecodeSourceValue)``
63+
- ``Timecode/adding(_:by:)-(FormattedTimecodeSourceValue,_)``
6464

6565
### Subtraction
6666

67-
- ``Timecode/subtract(_:)-1f5mq``
68-
- ``Timecode/subtract(_:by:)-19vp0``
67+
- ``Timecode/subtract(_:)-(Timecode)``
68+
- ``Timecode/subtract(_:by:)-(Timecode,_)``
6969

70-
- ``Timecode/subtract(_:)-9ctfn``
71-
- ``Timecode/subtract(_:by:)-9pl51``
70+
- ``Timecode/subtract(_:)-(Timecode.Components)``
71+
- ``Timecode/subtract(_:by:)-(Timecode.Components,_)``
7272

73-
- ``Timecode/subtract(_:)-835rt``
74-
- ``Timecode/subtract(_:by:)-e94u``
73+
- ``Timecode/subtract(_:)-(TimecodeSourceValue)``
74+
- ``Timecode/subtract(_:by:)-(TimecodeSourceValue,_)``
7575

76-
- ``Timecode/subtract(_:)-t638``
77-
- ``Timecode/subtract(_:by:)-uszg``
76+
- ``Timecode/subtract(_:)-(AsyncTimecodeSourceValue)``
77+
- ``Timecode/subtract(_:by:)-(AsyncTimecodeSourceValue,_)``
7878

79-
- ``Timecode/subtract(_:)-8x9n7``
80-
- ``Timecode/subtract(_:by:)-2c2fx``
79+
- ``Timecode/subtract(_:)-(GuaranteedTimecodeSourceValue)``
80+
- ``Timecode/subtract(_:by:)-(GuaranteedTimecodeSourceValue,_)``
8181

82-
- ``Timecode/subtract(_:)-3y14p``
83-
- ``Timecode/subtract(_:by:)-8zriq``
82+
- ``Timecode/subtract(_:)-(RichTimecodeSourceValue)``
83+
- ``Timecode/subtract(_:by:)-(RichTimecodeSourceValue,_)``
8484

85-
- ``Timecode/subtract(_:)-4eaq5``
86-
- ``Timecode/subtract(_:by:)-3y6tc``
85+
- ``Timecode/subtract(_:)-(AsyncRichTimecodeSourceValue)``
86+
- ``Timecode/subtract(_:by:)-(AsyncRichTimecodeSourceValue,_)``
8787

88-
- ``Timecode/subtract(_:)-8unrb``
89-
- ``Timecode/subtract(_:by:)-61jc0``
88+
- ``Timecode/subtract(_:)-(GuaranteedRichTimecodeSourceValue)``
89+
- ``Timecode/subtract(_:by:)-(GuaranteedRichTimecodeSourceValue,_)``
9090

91-
- ``Timecode/subtract(_:)-2clhm``
92-
- ``Timecode/subtract(_:by:)-951oa``
91+
- ``Timecode/subtract(_:)-(FormattedTimecodeSourceValue)``
92+
- ``Timecode/subtract(_:by:)-(FormattedTimecodeSourceValue,_)``
9393

94-
- ``Timecode/subtracting(_:)-2ms69``
95-
- ``Timecode/subtracting(_:by:)-9eks5``
94+
- ``Timecode/subtracting(_:)-(Timecode)``
95+
- ``Timecode/subtracting(_:by:)-(Timecode,_)``
9696

97-
- ``Timecode/subtracting(_:)-8nsmp``
98-
- ``Timecode/subtracting(_:by:)-6myzc``
97+
- ``Timecode/subtracting(_:)-(Timecode.Components)``
98+
- ``Timecode/subtracting(_:by:)-(Timecode.Components,_)``
9999

100-
- ``Timecode/subtracting(_:)-wqfx``
101-
- ``Timecode/subtracting(_:by:)-1edym``
100+
- ``Timecode/subtracting(_:)-(TimecodeSourceValue)``
101+
- ``Timecode/subtracting(_:by:)-(TimecodeSourceValue,_)``
102102

103-
- ``Timecode/subtracting(_:)-15gui``
104-
- ``Timecode/subtracting(_:by:)-57buu``
103+
- ``Timecode/subtracting(_:)-(AsyncTimecodeSourceValue)``
104+
- ``Timecode/subtracting(_:by:)-(AsyncTimecodeSourceValue,_)``
105105

106-
- ``Timecode/subtracting(_:)-3i0pb``
107-
- ``Timecode/subtracting(_:by:)-6xzzi``
106+
- ``Timecode/subtracting(_:)-(GuaranteedTimecodeSourceValue)``
107+
- ``Timecode/subtracting(_:by:)-(GuaranteedTimecodeSourceValue,_)``
108108

109-
- ``Timecode/subtracting(_:)-5jwl0``
110-
- ``Timecode/subtracting(_:by:)-7s2gd``
109+
- ``Timecode/subtracting(_:)-(RichTimecodeSourceValue)``
110+
- ``Timecode/subtracting(_:by:)-(RichTimecodeSourceValue,_)``
111111

112-
- ``Timecode/subtracting(_:)-3yet8``
113-
- ``Timecode/subtracting(_:by:)-85imt``
112+
- ``Timecode/subtracting(_:)-(AsyncRichTimecodeSourceValue)``
113+
- ``Timecode/subtracting(_:by:)-(AsyncRichTimecodeSourceValue,_)``
114114

115-
- ``Timecode/subtracting(_:)-2r7qo``
116-
- ``Timecode/subtracting(_:by:)-8g59b``
115+
- ``Timecode/subtracting(_:)-(GuaranteedRichTimecodeSourceValue)``
116+
- ``Timecode/subtracting(_:by:)-(GuaranteedRichTimecodeSourceValue,_)``
117117

118-
- ``Timecode/subtracting(_:)-94lq9``
119-
- ``Timecode/subtracting(_:by:)-8wjgl``
118+
- ``Timecode/subtracting(_:)-(FormattedTimecodeSourceValue)``
119+
- ``Timecode/subtracting(_:by:)-(FormattedTimecodeSourceValue,_)``
120120

121121
### Multiplication
122122

@@ -131,7 +131,7 @@ See the <doc:Math> article for a guide on using math methods.
131131
- ``Timecode/divide(_:)``
132132
- ``Timecode/divide(_:by:)``
133133

134-
- ``Timecode/dividing(_:)-411cg``
134+
- ``Timecode/dividing(_:)-(Timecode)``
135+
- ``Timecode/dividing(_:)-(Timecode.Components)``
136+
- ``Timecode/dividing(_:)->Timecode``
135137
- ``Timecode/dividing(_:by:)``
136-
- ``Timecode/dividing(_:)-6wrjc``
137-
- ``Timecode/dividing(_:)-5xpva``

Sources/SwiftTimecodeCore/Documentation.docc/Timecode-Set.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,43 @@ Set an existing ``Timecode`` instance to a new timecode.
66

77
### Source Value
88

9-
- ``Timecode/set(_:)-7h1e3``
10-
- ``Timecode/set(_:by:)-924y6``
11-
- ``Timecode/setting(_:)-8fycr``
12-
- ``Timecode/setting(_:by:)-4xxpr``
9+
- ``Timecode/set(_:)-(TimecodeSourceValue)``
10+
- ``Timecode/set(_:by:)-(TimecodeSourceValue,_)``
11+
- ``Timecode/setting(_:)-(TimecodeSourceValue)``
12+
- ``Timecode/setting(_:by:)-(TimecodeSourceValue,_)``
1313

1414
### Async Source Value
1515

16-
- ``Timecode/set(_:)-78azr``
17-
- ``Timecode/set(_:by:)-6pcmt``
18-
- ``Timecode/setting(_:)-3p2sr``
19-
- ``Timecode/setting(_:by:)-9bsvo``
16+
- ``Timecode/set(_:)-(AsyncTimecodeSourceValue)``
17+
- ``Timecode/set(_:by:)-(AsyncTimecodeSourceValue,_)``
18+
- ``Timecode/setting(_:)-(AsyncTimecodeSourceValue)``
19+
- ``Timecode/setting(_:by:)-(AsyncTimecodeSourceValue,_)``
2020

2121
### Guaranteed Source Value
2222

23-
- ``Timecode/set(_:)-2nzja``
24-
- ``Timecode/setting(_:)-7duyt``
23+
- ``Timecode/set(_:)-(GuaranteedTimecodeSourceValue)``
24+
- ``Timecode/setting(_:)-(GuaranteedTimecodeSourceValue)``
2525

2626
### Rich Source Value
2727

28-
- ``Timecode/set(_:)-1zpbl``
29-
- ``Timecode/set(_:by:)-8094b``
30-
- ``Timecode/setting(_:)-9wz6a``
31-
- ``Timecode/setting(_:by:)-4atep``
28+
- ``Timecode/set(_:)-(RichTimecodeSourceValue)``
29+
- ``Timecode/set(_:by:)-(RichTimecodeSourceValue,_)``
30+
- ``Timecode/setting(_:)-(RichTimecodeSourceValue)``
31+
- ``Timecode/setting(_:by:)-(RichTimecodeSourceValue,_)``
3232

3333
### Async Rich Source Value
3434

35-
- ``Timecode/set(_:)-5uzz``
36-
- ``Timecode/setting(_:)-5tip1``
35+
- ``Timecode/set(_:)-(AsyncRichTimecodeSourceValue)``
36+
- ``Timecode/setting(_:)-(AsyncRichTimecodeSourceValue)``
3737

3838
### Guaranteed Rich Source Value
3939

40-
- ``Timecode/set(_:)-1qlc2``
41-
- ``Timecode/setting(_:)-3evhh``
40+
- ``Timecode/set(_:)->_``
41+
- ``Timecode/setting(_:)-(GuaranteedRichTimecodeSourceValue)``
4242

4343
### Formatted Source Value
4444

45-
- ``Timecode/set(_:)-3il64``
46-
- ``Timecode/set(_:by:)-2wk8a``
47-
- ``Timecode/setting(_:)-37k7d``
48-
- ``Timecode/setting(_:by:)-8zidz``
45+
- ``Timecode/set(_:)-(FormattedTimecodeSourceValue)``
46+
- ``Timecode/set(_:by:)-(FormattedTimecodeSourceValue,_)``
47+
- ``Timecode/setting(_:)-(FormattedTimecodeSourceValue)``
48+
- ``Timecode/setting(_:by:)-(FormattedTimecodeSourceValue,_)``

0 commit comments

Comments
 (0)