Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
danielepantaleone committed Oct 26, 2024
1 parent 0c009ff commit 2c876f8
Show file tree
Hide file tree
Showing 241 changed files with 238 additions and 232 deletions.
2 changes: 1 addition & 1 deletion docs/data/documentation/blueconnect.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)"]}],"hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"sections":[],"metadata":{"symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"externalID":"s:11BlueConnect20BleAdvertisementDataVyACSDySSypGcfc","role":"symbol","roleHeading":"Initializer","modules":[{"name":"BlueConnect"}],"title":"init(_:)"},"identifier":{"url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a new "},{"type":"codeVoice","code":"BleAdvertisementData"},{"type":"text","text":" instance using CoreBluetooth’s advertisement data dictionary."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"advertisementData"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"advertisementData","content":[{"inlineContent":[{"text":"The CoreBluetooth advertisement data dictionary.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"inlineContent":[{"type":"text","text":"This initializer allows you to create a "},{"type":"codeVoice","code":"BleAdvertisementData"},{"text":" instance from the advertisement data provided by","type":"text"},{"type":"text","text":" "},{"type":"text","text":"the CoreBluetooth framework during peripheral discovery."}],"type":"paragraph"}],"kind":"content"}],"references":{"doc://BlueConnect/documentation/BlueConnect":{"url":"\/documentation\/blueconnect","title":"BlueConnect","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect","abstract":[],"type":"topic","kind":"symbol","role":"collection"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"type":"topic","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","navigatorTitle":[{"kind":"identifier","text":"BleAdvertisementData"}],"role":"symbol","url":"\/documentation\/blueconnect\/bleadvertisementdata","title":"BleAdvertisementData","kind":"symbol","abstract":[{"text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleAdvertisementData","kind":"identifier"}]},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/init(_:)":{"role":"symbol","url":"\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)","abstract":[{"text":"Initializes a new ","type":"text"},{"type":"codeVoice","code":"BleAdvertisementData"},{"type":"text","text":" instance using CoreBluetooth’s advertisement data dictionary."}],"identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)","fragments":[{"kind":"identifier","text":"init"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"kind":"symbol","title":"init(_:)","type":"topic"}}}
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"advertisementData","kind":"internalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"name":"advertisementData","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The CoreBluetooth advertisement data dictionary."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"This initializer allows you to create a ","type":"text"},{"type":"codeVoice","code":"BleAdvertisementData"},{"text":" instance from the advertisement data provided by","type":"text"},{"type":"text","text":" "},{"type":"text","text":"the CoreBluetooth framework during peripheral discovery."}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"sections":[],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"codeVoice","code":"BleAdvertisementData"},{"text":" instance using CoreBluetooth’s advertisement data dictionary.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)"]}],"metadata":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"modules":[{"name":"BlueConnect"}],"symbolKind":"init","roleHeading":"Initializer","externalID":"s:11BlueConnect20BleAdvertisementDataVyACSDySSypGcfc","title":"init(_:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"title":"BleAdvertisementData","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BleAdvertisementData"}],"identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","navigatorTitle":[{"kind":"identifier","text":"BleAdvertisementData"}],"abstract":[{"type":"text","text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data."}],"url":"\/documentation\/blueconnect\/bleadvertisementdata","kind":"symbol"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/init(_:)":{"kind":"symbol","title":"init(_:)","url":"\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"Initializes a new "},{"code":"BleAdvertisementData","type":"codeVoice"},{"type":"text","text":" instance using CoreBluetooth’s advertisement data dictionary."}]},"doc://BlueConnect/documentation/BlueConnect":{"url":"\/documentation\/blueconnect","abstract":[],"role":"collection","type":"topic","title":"BlueConnect","kind":"symbol","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect"}}}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isConnectable"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"This property returns ","type":"text"},{"code":"true","type":"codeVoice"},{"type":"text","text":" if the advertisement data indicates that the peripheral’s advertising event type is connectable."},{"type":"text","text":" "},{"text":"If the event type is not connectable, this property returns ","type":"text"},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:11BlueConnect20BleAdvertisementDataV13isConnectableSbvp","roleHeading":"Instance Property","title":"isConnectable","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isConnectable","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"modules":[{"name":"BlueConnect"}],"symbolKind":"property","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"abstract":[{"type":"text","text":"A Boolean value indicating whether the peripheral is connectable."}],"references":{"doc://BlueConnect/documentation/BlueConnect":{"url":"\/documentation\/blueconnect","title":"BlueConnect","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect","abstract":[],"type":"topic","kind":"symbol","role":"collection"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"type":"topic","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","navigatorTitle":[{"kind":"identifier","text":"BleAdvertisementData"}],"role":"symbol","url":"\/documentation\/blueconnect\/bleadvertisementdata","title":"BleAdvertisementData","kind":"symbol","abstract":[{"text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleAdvertisementData","kind":"identifier"}]},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/isConnectable":{"identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isConnectable","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isConnectable","url":"\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable","kind":"symbol","abstract":[{"text":"A Boolean value indicating whether the peripheral is connectable.","type":"text"}]}}}
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable"]}],"metadata":{"externalID":"s:11BlueConnect20BleAdvertisementDataV13isConnectableSbvp","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isConnectable","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"BlueConnect"}],"title":"isConnectable"},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A Boolean value indicating whether the peripheral is connectable."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isConnectable","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"This property returns ","type":"text"},{"type":"codeVoice","code":"true"},{"type":"text","text":" if the advertisement data indicates that the peripheral’s advertising event type is connectable."},{"type":"text","text":" "},{"type":"text","text":"If the event type is not connectable, this property returns "},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"references":{"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"title":"BleAdvertisementData","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BleAdvertisementData"}],"identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","navigatorTitle":[{"kind":"identifier","text":"BleAdvertisementData"}],"abstract":[{"type":"text","text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data."}],"url":"\/documentation\/blueconnect\/bleadvertisementdata","kind":"symbol"},"doc://BlueConnect/documentation/BlueConnect":{"url":"\/documentation\/blueconnect","abstract":[],"role":"collection","type":"topic","title":"BlueConnect","kind":"symbol","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/isConnectable":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isConnectable","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable","abstract":[{"type":"text","text":"A Boolean value indicating whether the peripheral is connectable."}],"role":"symbol","type":"topic","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable","kind":"symbol","title":"isConnectable"}}}
Loading

0 comments on commit 2c876f8

Please sign in to comment.