Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
danielepantaleone committed Nov 18, 2024
1 parent 5a705c2 commit d381514
Show file tree
Hide file tree
Showing 444 changed files with 441 additions and 243 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 @@
{"hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"kind":"symbol","abstract":[{"text":"Initializes a new ","type":"text"},{"type":"codeVoice","code":"BleAdvertisementData"},{"type":"text","text":" instance using CoreBluetooth’s advertisement data dictionary."}],"sections":[],"metadata":{"title":"init(_:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"roleHeading":"Initializer","symbolKind":"init","externalID":"s:11BlueConnect20BleAdvertisementDataVyACSDySSypGcfc","modules":[{"name":"BlueConnect"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"advertisementData"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"name":"advertisementData","content":[{"type":"paragraph","inlineContent":[{"text":"The CoreBluetooth advertisement data dictionary.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"inlineContent":[{"text":"This initializer allows you to create a ","type":"text"},{"type":"codeVoice","code":"BleAdvertisementData"},{"type":"text","text":" instance from the advertisement data provided by"},{"type":"text","text":" "},{"type":"text","text":"the CoreBluetooth framework during peripheral discovery."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/init(_:)":{"abstract":[{"type":"text","text":"Initializes a new "},{"code":"BleAdvertisementData","type":"codeVoice"},{"text":" instance using CoreBluetooth’s advertisement data dictionary.","type":"text"}],"kind":"symbol","url":"\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)","title":"init(_:)","type":"topic"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BleAdvertisementData"}],"url":"\/documentation\/blueconnect\/bleadvertisementdata","kind":"symbol","abstract":[{"type":"text","text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data."}],"type":"topic","title":"BleAdvertisementData","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"BleAdvertisementData"}]},"doc://BlueConnect/documentation/BlueConnect":{"title":"BlueConnect","kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/blueconnect","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect","role":"collection"}}}
{"abstract":[{"text":"Initializes a new ","type":"text"},{"type":"codeVoice","code":"BleAdvertisementData"},{"text":" instance using CoreBluetooth’s advertisement data dictionary.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"advertisementData","kind":"internalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"advertisementData","content":[{"type":"paragraph","inlineContent":[{"text":"The CoreBluetooth advertisement data dictionary.","type":"text"}]}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This initializer allows you to create a "},{"code":"BleAdvertisementData","type":"codeVoice"},{"type":"text","text":" instance from the advertisement data provided by"},{"text":" ","type":"text"},{"type":"text","text":"the CoreBluetooth framework during peripheral discovery."}]}]}],"metadata":{"role":"symbol","title":"init(_:)","fragments":[{"kind":"identifier","text":"init"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"modules":[{"name":"BlueConnect"}],"symbolKind":"init","externalID":"s:11BlueConnect20BleAdvertisementDataVyACSDySSypGcfc","roleHeading":"Initializer"},"variants":[{"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/init(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://BlueConnect/documentation/BlueConnect":{"abstract":[],"url":"\/documentation\/blueconnect","title":"BlueConnect","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect","kind":"symbol","type":"topic","role":"collection"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/init(_:)":{"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"title":"init(_:)","kind":"symbol","role":"symbol","url":"\/documentation\/blueconnect\/bleadvertisementdata\/init(_:)","type":"topic","identifier":"doc:\/\/BlueConnect\/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."}]},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"title":"BleAdvertisementData","type":"topic","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","url":"\/documentation\/blueconnect\/bleadvertisementdata","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleAdvertisementData","kind":"identifier"}],"abstract":[{"text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data.","type":"text"}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"BleAdvertisementData","kind":"identifier"}]}}}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isConnectable","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:11BlueConnect20BleAdvertisementDataV13isConnectableSbvp","title":"isConnectable","role":"symbol","modules":[{"name":"BlueConnect"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable"},"abstract":[{"type":"text","text":"A Boolean value indicating whether the peripheral is connectable."}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isConnectable","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"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":" "},{"text":"If the event type is not connectable, this property returns ","type":"text"},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}]}]}],"variants":[{"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/BlueConnect\/documentation\/BlueConnect","doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData"]]},"kind":"symbol","references":{"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/isConnectable":{"identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable","abstract":[{"type":"text","text":"A Boolean value indicating whether the peripheral is connectable."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isConnectable","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isConnectable","url":"\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable","type":"topic","kind":"symbol","role":"symbol"},"doc://BlueConnect/documentation/BlueConnect":{"title":"BlueConnect","kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/blueconnect","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect","role":"collection"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BleAdvertisementData"}],"url":"\/documentation\/blueconnect\/bleadvertisementdata","kind":"symbol","abstract":[{"type":"text","text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data."}],"type":"topic","title":"BleAdvertisementData","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"BleAdvertisementData"}]}}}
{"sections":[],"identifier":{"url":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"BlueConnect"}],"title":"isConnectable","roleHeading":"Instance Property","role":"symbol","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"}]},"kind":"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."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isConnectable","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"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"},{"type":"text","text":"."}]}]}],"references":{"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData/isConnectable":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isConnectable","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isConnectable","kind":"symbol","role":"symbol","url":"\/documentation\/blueconnect\/bleadvertisementdata\/isconnectable","type":"topic","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData\/isConnectable","abstract":[{"type":"text","text":"A Boolean value indicating whether the peripheral is connectable."}]},"doc://BlueConnect/documentation/BlueConnect":{"abstract":[],"url":"\/documentation\/blueconnect","title":"BlueConnect","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect","kind":"symbol","type":"topic","role":"collection"},"doc://BlueConnect/documentation/BlueConnect/BleAdvertisementData":{"title":"BleAdvertisementData","type":"topic","identifier":"doc:\/\/BlueConnect\/documentation\/BlueConnect\/BleAdvertisementData","url":"\/documentation\/blueconnect\/bleadvertisementdata","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleAdvertisementData","kind":"identifier"}],"abstract":[{"text":"A convenience class that helps interpret and access Bluetooth Low Energy (BLE) advertisement data.","type":"text"}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"BleAdvertisementData","kind":"identifier"}]}}}
Loading

0 comments on commit d381514

Please sign in to comment.