Skip to content

Commit e1e8a32

Browse files
committed
[SPARK-51997] Mark nodoc to hide generated and internal classes from docs
### What changes were proposed in this pull request? This PR aims mark `nodoc` to hide generated and internal classes from docs. ### Why are the changes needed? Since #107, the documentation is visible here. - https://swiftpackageindex.com/apache/spark-connect-swift/main/documentation/sparkconnect We need to simplify the documentation to focus `Spark Connect for Swift` itself by hiding irrelevant information . For example, `Arrow`-related information will be removed eventually when we start to use the official `Apache Arrow` release. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Manual review. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #113 from dongjoon-hyun/SPARK-51997. Authored-by: Dongjoon Hyun <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
1 parent 5684325 commit e1e8a32

22 files changed

+98
-0
lines changed

Sources/SparkConnect/ArrowArray.swift

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public protocol ArrowArrayHolder {
2122
var type: ArrowType { get }
2223
var length: UInt { get }
@@ -28,6 +29,7 @@ public protocol ArrowArrayHolder {
2829
var getArrowColumn: (ArrowField, [ArrowArrayHolder]) throws -> ArrowColumn { get }
2930
}
3031

32+
/// @nodoc
3133
public class ArrowArrayHolderImpl: ArrowArrayHolder {
3234
public let data: ArrowData
3335
public let type: ArrowType
@@ -121,6 +123,7 @@ public class ArrowArrayHolderImpl: ArrowArrayHolder {
121123
}
122124
}
123125

126+
/// @nodoc
124127
public class ArrowArray<T>: AsString, AnyArray {
125128
public typealias ItemType = T
126129
public let arrowData: ArrowData
@@ -160,6 +163,7 @@ public class ArrowArray<T>: AsString, AnyArray {
160163
}
161164
}
162165

166+
/// @nodoc
163167
public class FixedArray<T>: ArrowArray<T> {
164168
public override subscript(_ index: UInt) -> T? {
165169
if self.arrowData.isNull(index) {
@@ -171,6 +175,7 @@ public class FixedArray<T>: ArrowArray<T> {
171175
}
172176
}
173177

178+
/// @nodoc
174179
public class StringArray: ArrowArray<String> {
175180
public override subscript(_ index: UInt) -> String? {
176181
let offsetIndex = MemoryLayout<Int32>.stride * Int(index)
@@ -197,6 +202,7 @@ public class StringArray: ArrowArray<String> {
197202
}
198203
}
199204

205+
/// @nodoc
200206
public class BoolArray: ArrowArray<Bool> {
201207
public override subscript(_ index: UInt) -> Bool? {
202208
if self.arrowData.isNull(index) {
@@ -208,6 +214,7 @@ public class BoolArray: ArrowArray<Bool> {
208214
}
209215
}
210216

217+
/// @nodoc
211218
public class Date32Array: ArrowArray<Date> {
212219
public override subscript(_ index: UInt) -> Date? {
213220
if self.arrowData.isNull(index) {
@@ -221,6 +228,7 @@ public class Date32Array: ArrowArray<Date> {
221228
}
222229
}
223230

231+
/// @nodoc
224232
public class Date64Array: ArrowArray<Date> {
225233
public override subscript(_ index: UInt) -> Date? {
226234
if self.arrowData.isNull(index) {
@@ -234,9 +242,12 @@ public class Date64Array: ArrowArray<Date> {
234242
}
235243
}
236244

245+
/// @nodoc
237246
public class Time32Array: FixedArray<Time32> {}
247+
/// @nodoc
238248
public class Time64Array: FixedArray<Time64> {}
239249

250+
/// @nodoc
240251
public class BinaryArray: ArrowArray<Data> {
241252
public struct Options {
242253
public var printAsHex = false
@@ -279,6 +290,7 @@ public class BinaryArray: ArrowArray<Data> {
279290
}
280291
}
281292

293+
/// @nodoc
282294
public class StructArray: ArrowArray<[Any?]> {
283295
public private(set) var arrowFields: [ArrowArrayHolder]?
284296
public required init(_ arrowData: ArrowData) throws {

Sources/SparkConnect/ArrowArrayBuilder.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public protocol ArrowArrayHolderBuilder {
2122
func toHolder() throws -> ArrowArrayHolder
2223
func appendAny(_ val: Any?)

Sources/SparkConnect/ArrowBuffer.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public class ArrowBuffer {
2122
static let minLength: UInt = 1 << 5
2223
static let maxLength = UInt.max

Sources/SparkConnect/ArrowBufferBuilder.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public protocol ArrowBufferBuilder {
2122
associatedtype ItemType
2223
var capacity: UInt { get }

Sources/SparkConnect/ArrowData.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public class ArrowData {
2122
public let type: ArrowType
2223
public let buffers: [ArrowBuffer]

Sources/SparkConnect/ArrowDecoder.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public class ArrowDecoder: Decoder {
2122
var rbIndex: UInt = 0
2223
var singleRBCol: Int = 0

Sources/SparkConnect/ArrowEncoder.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public class ArrowEncoder: Encoder {
2122
public private(set) var builders = [String: ArrowArrayHolderBuilder]()
2223
private var byIndex = [String]()

Sources/SparkConnect/ArrowReader.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import Foundation
2121
let FILEMARKER = "ARROW1"
2222
let CONTINUATIONMARKER = -1
2323

24+
/// @nodoc
2425
public class ArrowReader { // swiftlint:disable:this type_body_length
2526
private class RecordBatchData {
2627
let schema: org_apache_arrow_flatbuf_Schema

Sources/SparkConnect/ArrowReaderHelper.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import FlatBuffers
1919
import Foundation
2020

21+
/// @nodoc
2122
private func makeBinaryHolder(
2223
_ buffers: [ArrowBuffer],
2324
nullCount: UInt

Sources/SparkConnect/ArrowSchema.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import Foundation
1919

20+
/// @nodoc
2021
public class ArrowField {
2122
public let type: ArrowType
2223
public let name: String
@@ -29,6 +30,7 @@ public class ArrowField {
2930
}
3031
}
3132

33+
/// @nodoc
3234
public class ArrowSchema {
3335
public let fields: [ArrowField]
3436
public let fieldLookup: [String: Int]

0 commit comments

Comments
 (0)