Skip to content

Commit f649303

Browse files
lorenteylorentey
authored
Merge pull request #228 from lorentey/DocC
Start working on DocC support
2 parents bef610f + 1c147e3 commit f649303

File tree

25 files changed

+1691
-124
lines changed

25 files changed

+1691
-124
lines changed

‎Sources/BitCollections/BitCollections.docc/BitCollections.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ``BitCollections``
2+
3+
**Swift Collections** is an open-source package of data structure implementations for the Swift programming language.
4+
5+
## Overview
6+
7+
8+
9+
#### Additional Resources
10+
11+
- [`Swift Collections` on GitHub](https://github.com/apple/swift-collections/)
12+
- [`Swift Collections` on the Swift Forums](https://forums.swift.org/c/related-projects/collections/72)
13+
14+
15+
## Topics
16+
17+
### Structures
18+
19+
- ``BitSet``
20+
- ``BitArray``

‎Sources/BitCollections/BitCollections.docc/Extensions/BitArray.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# ``BitCollections/BitArray``
2+
3+
<!-- Summary -->
4+
5+
<!-- ## Overview -->
6+
7+
## Topics
8+
9+
### Creating a Bit Array
10+
11+
- ``init()``
12+
- ``init(_:)-2y0wv``
13+
- ``init(repeating:count:)-4j5yd``
14+
- ``init(_:)-6ldyw``
15+
- ``init(_:)-4tksd``
16+
- ``init(_:)-765d2``
17+
- ``init(bitPattern:)``
18+
- ``random(count:)``
19+
- ``random(count:using:)``
20+
21+
### Accessing Elements
22+
23+
- ``subscript(_:)-51ccj``
24+
- ``subscript(_:)-944vg``
25+
- ``first``
26+
- ``last``
27+
28+
### Adding Elements
29+
30+
- ``append(_:)``
31+
- ``append(contentsOf:)-18dwf``
32+
- ``append(contentsOf:)-576q4``
33+
- ``append(contentsOf:)-8xkr8``
34+
- ``insert(_:at:)``
35+
- ``insert(contentsOf:at:)-7e1xn``
36+
- ``insert(contentsOf:at:)-35dp3``
37+
- ``insert(contentsOf:at:)-1wsgw``
38+
- ``truncateOrExtend(toCount:with:)``
39+
40+
### Removing Elements
41+
42+
- ``remove(at:)-7ij12``
43+
- ``removeAll(keepingCapacity:)-5tkge``
44+
- ``removeAll(where:)-7tv7z``
45+
- ``removeSubrange(_:)-86ou8``
46+
- ``removeSubrange(_:)-18qe7``
47+
- ``removeLast()``
48+
- ``removeLast(_:)``
49+
- ``removeFirst()``
50+
- ``removeFirst(_:)``
51+
- ``popLast()``
52+
53+
### Replacing Elements
54+
55+
- ``fill(in:with:)``
56+
- ``fill(with:)``
57+
- ``replaceSubrange(_:with:)-163u2``
58+
- ``replaceSubrange(_:with:)-875d8``
59+
- ``replaceSubrange(_:with:)-2i7lu``
60+
- ``replaceSubrange(_:with:)-b5ou``
61+
62+
### Bitwise Operators
63+
64+
- ``&(_:_:)``
65+
- ``_(_:_:)-1rhw``
66+
- ``_(_:_:)-56s54``
67+
- ``~(_:)``
68+
- ``&=(_:_:)``
69+
- ``_=(_:_:)-69yf0``
70+
- ``_=(_:_:)-icef``

‎Sources/BitCollections/BitCollections.docc/Extensions/BitSet.Counted.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# ``BitCollections/BitSet/Counted-swift.struct``
2+
3+
<!-- Summary -->
4+
5+
<!-- ## Overview -->
6+
7+
## Topics
8+
9+
### Collection Views
10+
11+
- ``uncounted``
12+
13+
### Creating a Set
14+
15+
- ``init()``
16+
- ``init(reservingCapacity:)``
17+
- ``init(_:)-15cws``
18+
- ``init(_:)-38hho``
19+
- ``init(_:)-2of3i``
20+
- ``init(_:)-5fhls``
21+
- ``init(bitPattern:)``
22+
- ``init(words:)``
23+
- ``random(upTo:)``
24+
- ``random(upTo:using:)``
25+
26+
### Finding Elements
27+
28+
- ``contains(_:)``
29+
- ``firstIndex(of:)``
30+
- ``lastIndex(of:)``
31+
32+
### Adding and Updating Elements
33+
34+
- ``insert(_:)``
35+
- ``update(with:)``
36+
37+
### Removing Elements
38+
39+
- ``filter(_:)``
40+
- ``remove(_:)``
41+
- ``remove(at:)``
42+
43+
### Sorted Set Operations
44+
45+
- ``subscript(member:)``
46+
- ``subscript(members:)-5nkxk``
47+
- ``subscript(members:)-5xfq5``
48+
- ``min()``
49+
- ``max()``
50+
- ``sorted()``
51+
52+
### Binary Set Operations
53+
54+
- ``intersection(_:)-1wfb5``
55+
- ``intersection(_:)-4evdp``
56+
- ``intersection(_:)-9rtcc``
57+
- ``intersection(_:)-13us``
58+
59+
- ``union(_:)-2okwt``
60+
- ``union(_:)-pwqf``
61+
- ``union(_:)-18u31``
62+
- ``union(_:)-8ysz9``
63+
64+
- ``subtracting(_:)-7u4tf``
65+
- ``subtracting(_:)-5vgml``
66+
- ``subtracting(_:)-6scy1``
67+
- ``subtracting(_:)-82loi``
68+
69+
- ``symmetricDifference(_:)-84e40``
70+
- ``symmetricDifference(_:)-3suo3``
71+
- ``symmetricDifference(_:)-7zx5q``
72+
- ``symmetricDifference(_:)-46ni1``
73+
74+
- ``formIntersection(_:)-49and``
75+
- ``formIntersection(_:)-49a0x``
76+
- ``formIntersection(_:)-79anv``
77+
- ``formIntersection(_:)-3zoc4``
78+
79+
- ``formUnion(_:)-c6a3``
80+
- ``formUnion(_:)-c5kv``
81+
- ``formUnion(_:)-2f05x``
82+
- ``formUnion(_:)-8kilf``
83+
84+
- ``subtract(_:)-2hzty``
85+
- ``subtract(_:)-2i1qq``
86+
- ``subtract(_:)-32jtb``
87+
- ``subtract(_:)-75xgt``
88+
89+
- ``formSymmetricDifference(_:)-6vskl``
90+
- ``formSymmetricDifference(_:)-6vs05``
91+
- ``formSymmetricDifference(_:)-d2kd``
92+
- ``formSymmetricDifference(_:)-54ghn``
93+
94+
### Binary Set Predicates
95+
96+
- ``==(_:_:)``
97+
- ``isEqual(to:)-5bw9h``
98+
- ``isEqual(to:)-8jxq5``
99+
- ``isEqual(to:)-7w9qy``
100+
- ``isEqual(to:)-9tnfo``
101+
102+
- ``isSubset(of:)-8iy8c``
103+
- ``isSubset(of:)-1r41b``
104+
- ``isSubset(of:)-1dz0p``
105+
- ``isSubset(of:)-3bq5m``
106+
107+
- ``isSuperset(of:)-48i5c``
108+
- ``isSuperset(of:)-10gu8``
109+
- ``isSuperset(of:)-8b7lq``
110+
- ``isSuperset(of:)-6slai``
111+
112+
- ``isStrictSubset(of:)-5ry1b``
113+
- ``isStrictSubset(of:)-2ndu3``
114+
- ``isStrictSubset(of:)-9iul0``
115+
- ``isStrictSubset(of:)-2pq1j``
116+
117+
- ``isStrictSuperset(of:)-9mgmd``
118+
- ``isStrictSuperset(of:)-6hw4t``
119+
- ``isStrictSuperset(of:)-1ya0j``
120+
- ``isStrictSuperset(of:)-4qt1e``
121+
122+
- ``isDisjoint(with:)-9wyku``
123+
- ``isDisjoint(with:)-5fww0``
124+
- ``isDisjoint(with:)-6p0t7``
125+
- ``isDisjoint(with:)-eujj``

‎Sources/BitCollections/BitCollections.docc/Extensions/BitSet.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# ``BitCollections/BitSet``
2+
3+
<!-- Summary -->
4+
5+
<!-- ## Overview -->
6+
7+
## Topics
8+
9+
### Collection Views
10+
11+
- ``Counted-swift.struct``
12+
- ``counted-swift.property``
13+
14+
### Creating a Set
15+
16+
- ``init()``
17+
- ``init(reservingCapacity:)``
18+
- ``init(_:)-15cws``
19+
- ``init(_:)-38hho``
20+
- ``init(_:)-2of3i``
21+
- ``init(_:)-5fhls``
22+
- ``init(bitPattern:)``
23+
- ``init(words:)``
24+
- ``random(upTo:)``
25+
- ``random(upTo:using:)``
26+
27+
### Finding Elements
28+
29+
- ``contains(_:)``
30+
- ``firstIndex(of:)``
31+
- ``lastIndex(of:)``
32+
33+
### Adding and Updating Elements
34+
35+
- ``insert(_:)``
36+
- ``update(with:)``
37+
38+
### Removing Elements
39+
40+
- ``filter(_:)``
41+
- ``remove(_:)``
42+
- ``remove(at:)``
43+
44+
### Sorted Set Operations
45+
46+
- ``subscript(member:)``
47+
- ``subscript(members:)-5nkxk``
48+
- ``subscript(members:)-5xfq5``
49+
- ``min()``
50+
- ``max()``
51+
- ``sorted()``
52+
53+
### Combining Sets
54+
55+
- ``intersection(_:)-84q4u``
56+
- ``intersection(_:)-8hcl9``
57+
- ``intersection(_:)-7l8p3``
58+
- ``intersection(_:)-7kgi``
59+
60+
- ``union(_:)-5kqmx``
61+
- ``union(_:)-6mj8``
62+
- ``union(_:)-50wc4``
63+
- ``union(_:)-10had``
64+
65+
- ``subtracting(_:)-79e0o``
66+
- ``subtracting(_:)-7re82``
67+
- ``subtracting(_:)-7rn26``
68+
- ``subtracting(_:)-42s7d``
69+
70+
- ``symmetricDifference(_:)-55kqn``
71+
- ``symmetricDifference(_:)-5xt65``
72+
- ``symmetricDifference(_:)-91kh8``
73+
- ``symmetricDifference(_:)-79wfx``
74+
75+
- ``formIntersection(_:)-u07v``
76+
- ``formIntersection(_:)-87gjl``
77+
- ``formIntersection(_:)-9gffv``
78+
- ``formIntersection(_:)-8t2je``
79+
80+
- ``formUnion(_:)-72o7q``
81+
- ``formUnion(_:)-370hb``
82+
- ``formUnion(_:)-7tw8j``
83+
- ``formUnion(_:)-12ll3``
84+
85+
- ``subtract(_:)-9aabm``
86+
- ``subtract(_:)-1o083``
87+
- ``subtract(_:)-6kijg``
88+
- ``subtract(_:)-3pynh``
89+
90+
- ``formSymmetricDifference(_:)-2le2k``
91+
- ``formSymmetricDifference(_:)-5edyr``
92+
- ``formSymmetricDifference(_:)-7wole``
93+
- ``formSymmetricDifference(_:)-8vcnf``
94+
95+
### Comparing Sets
96+
97+
- ``==(_:_:)``
98+
- ``isEqual(to:)-5zfpo``
99+
- ``isEqual(to:)-93d52``
100+
- ``isEqual(to:)-542zl``
101+
- ``isEqual(to:)-1d66i``
102+
103+
- ``isSubset(of:)-73apg``
104+
- ``isSubset(of:)-14xt1``
105+
- ``isSubset(of:)-4mj71``
106+
- ``isSubset(of:)-20wxs``
107+
108+
- ``isSuperset(of:)-1mfg2``
109+
- ``isSuperset(of:)-5adir``
110+
- ``isSuperset(of:)-4y68t``
111+
- ``isSuperset(of:)-2m7mj``
112+
113+
- ``isStrictSubset(of:)-8m1z6``
114+
- ``isStrictSubset(of:)-3y2l1``
115+
- ``isStrictSubset(of:)-97rky``
116+
- ``isStrictSubset(of:)-p3zj``
117+
118+
- ``isStrictSuperset(of:)-6e5gm``
119+
- ``isStrictSuperset(of:)-735zn``
120+
- ``isStrictSuperset(of:)-26acy``
121+
- ``isStrictSuperset(of:)-5jmxx``
122+
123+
- ``isDisjoint(with:)-2cdg6``
124+
- ``isDisjoint(with:)-3klxy``
125+
- ``isDisjoint(with:)-4uidy``
126+
- ``isDisjoint(with:)-78a8w``
127+
128+
### Memory Management
129+
130+
- ``reserveCapacity(_:)``

‎Sources/Collections/Collections.docc/Collections.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# ``Collections``
2+
3+
**Swift Collections** is an open-source package of data structure implementations for the Swift programming language.
4+
5+
## Overview
6+
7+
8+
9+
#### Additional Resources
10+
11+
- [`Swift Collections` on GitHub](https://github.com/apple/swift-collections/)
12+
- [`Swift Collections` on the Swift Forums](https://forums.swift.org/c/related-projects/collections/72)
13+
14+
15+
## Topics
16+
17+
### Bit Collections
18+
19+
- ``BitSet``
20+
- ``BitArray``
21+
22+
### Deque Module
23+
24+
- ``Deque``
25+
26+
### Heap Module
27+
28+
- ``Heap``
29+
30+
### Ordered Collections
31+
32+
- ``OrderedSet``
33+
- ``OrderedDictionary``
34+
35+
### Persistent Collections
36+
37+
- ``PersistentSet``
38+
- ``PersistentDictionary``

0 commit comments

Comments
 (0)