Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phisakel committed Jan 14, 2025
1 parent cfed044 commit a81e70d
Show file tree
Hide file tree
Showing 329 changed files with 295 additions and 301 deletions.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/mdocdatatransfer18013.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode"},"metadata":{"modules":[{"name":"MdocDataTransfer18013"}],"navigatorTitle":[{"kind":"identifier","text":"BleTransferMode"}],"roleHeading":"Enumeration","title":"BleTransferMode","symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleTransferMode","kind":"identifier"}],"role":"symbol","externalID":"s:21MdocDataTransfer1801315BleTransferModeO"},"sections":[],"topicSections":[{"identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/client","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/server"],"generated":true,"anchor":"Enumeration-Cases","title":"Enumeration Cases"},{"title":"Type Properties","anchor":"Type-Properties","identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/BASE_UUID_SUFFIX_SERVICE","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/QRHandover"],"generated":true},{"anchor":"Default-Implementations","generated":true,"title":"Default Implementations","identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/Equatable-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleTransferMode","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"type":"heading","text":"Overview","anchor":"overview","level":2},{"inlineContent":[{"type":"text","text":"The four static variables are used to signal the start and the end of the communication. This is done by sending the bytes 0x01 and 0x02 for the start and end of the communication, respectively. For the start and end of the data transmission, the bytes 0x01 and 0x00 are used."}],"type":"paragraph"}],"kind":"content"}],"relationshipsSections":[{"identifiers":["doc:\/\/MdocDataTransfer18013\/SQ","doc:\/\/MdocDataTransfer18013\/SH","doc:\/\/MdocDataTransfer18013\/s8SendableP"],"title":"Conforms To","kind":"relationships","type":"conformsTo"}],"variants":[{"paths":["\/documentation\/mdocdatatransfer18013\/bletransfermode"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"The enum BleTransferMode defines the two roles in the communication, which can be a server or a client."}],"references":{"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/BASE_UUID_SUFFIX_SERVICE":{"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/base_uuid_suffix_service","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"BASE_UUID_SUFFIX_SERVICE","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"BASE_UUID_SUFFIX_SERVICE","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/BASE_UUID_SUFFIX_SERVICE","abstract":[]},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/client":{"kind":"symbol","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/client","role":"symbol","abstract":[],"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/client","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"client"}],"title":"BleTransferMode.client","type":"topic"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/server":{"role":"symbol","title":"BleTransferMode.server","type":"topic","kind":"symbol","url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/server","abstract":[],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"server"}],"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/server"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/QRHandover":{"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/qrhandover","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"QRHandover","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:9SwiftCBOR0B0O","text":"CBOR","kind":"typeIdentifier"}],"title":"QRHandover","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/QRHandover","abstract":[]},"doc://MdocDataTransfer18013/s8SendableP":{"identifier":"doc:\/\/MdocDataTransfer18013\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://MdocDataTransfer18013/SQ":{"identifier":"doc:\/\/MdocDataTransfer18013\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","type":"topic","kind":"article","url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/equatable-implementations","abstract":[],"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/Equatable-Implementations"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013":{"type":"topic","kind":"symbol","url":"\/documentation\/mdocdatatransfer18013","abstract":[],"role":"collection","title":"MdocDataTransfer18013","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode":{"role":"symbol","type":"topic","abstract":[{"text":"The enum BleTransferMode defines the two roles in the communication, which can be a server or a client.","type":"text"}],"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BleTransferMode","kind":"identifier"}],"navigatorTitle":[{"text":"BleTransferMode","kind":"identifier"}],"title":"BleTransferMode","url":"\/documentation\/mdocdatatransfer18013\/bletransfermode"},"doc://MdocDataTransfer18013/SH":{"identifier":"doc:\/\/MdocDataTransfer18013\/SH","type":"unresolvable","title":"Swift.Hashable"}}}
{"hierarchy":{"paths":[["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"BleTransferMode","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","text":"Overview","anchor":"overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The four static variables are used to signal the start and the end of the communication. This is done by sending the bytes 0x01 and 0x02 for the start and end of the communication, respectively. For the start and end of the data transmission, the bytes 0x01 and 0x00 are used."}]}],"kind":"content"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/mdocdatatransfer18013\/bletransfermode"]}],"topicSections":[{"identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/client","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/server"],"title":"Enumeration Cases","anchor":"Enumeration-Cases","generated":true},{"identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/BASE_UUID_SUFFIX_SERVICE","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/QRHandover"],"anchor":"Type-Properties","generated":true,"title":"Type Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"BleTransferMode","kind":"identifier"}],"modules":[{"name":"MdocDataTransfer18013"}],"navigatorTitle":[{"text":"BleTransferMode","kind":"identifier"}],"externalID":"s:21MdocDataTransfer1801315BleTransferModeO","title":"BleTransferMode","role":"symbol","symbolKind":"enum","roleHeading":"Enumeration"},"kind":"symbol","abstract":[{"type":"text","text":"The enum BleTransferMode defines the two roles in the communication, which can be a server or a client."}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/MdocDataTransfer18013\/SQ","doc:\/\/MdocDataTransfer18013\/SH","doc:\/\/MdocDataTransfer18013\/s8SendableP"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode"},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013":{"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013","url":"\/documentation\/mdocdatatransfer18013","title":"MdocDataTransfer18013","role":"collection","abstract":[],"type":"topic","kind":"symbol"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/Equatable-Implementations":{"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/Equatable-Implementations","role":"collectionGroup","url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/equatable-implementations","kind":"article","abstract":[],"type":"topic","title":"Equatable Implementations"},"doc://MdocDataTransfer18013/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/MdocDataTransfer18013\/SH"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/server":{"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/server","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"server","kind":"identifier"}],"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/server","kind":"symbol","abstract":[],"type":"topic","title":"BleTransferMode.server"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/BASE_UUID_SUFFIX_SERVICE":{"type":"topic","title":"BASE_UUID_SUFFIX_SERVICE","kind":"symbol","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/BASE_UUID_SUFFIX_SERVICE","abstract":[],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BASE_UUID_SUFFIX_SERVICE","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/base_uuid_suffix_service"},"doc://MdocDataTransfer18013/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/MdocDataTransfer18013\/SQ","type":"unresolvable"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/QRHandover":{"type":"topic","title":"QRHandover","kind":"symbol","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/QRHandover","abstract":[],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"QRHandover","kind":"identifier"},{"kind":"text","text":": "},{"text":"CBOR","kind":"typeIdentifier","preciseIdentifier":"s:9SwiftCBOR0B0O"}],"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/qrhandover"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode/client":{"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode\/client","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"client","kind":"identifier"}],"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode\/client","kind":"symbol","abstract":[],"type":"topic","title":"BleTransferMode.client"},"doc://MdocDataTransfer18013/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/MdocDataTransfer18013\/s8SendableP"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode":{"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"BleTransferMode","kind":"identifier"}],"url":"\/documentation\/mdocdatatransfer18013\/bletransfermode","kind":"symbol","abstract":[{"text":"The enum BleTransferMode defines the two roles in the communication, which can be a server or a client.","type":"text"}],"type":"topic","title":"BleTransferMode","navigatorTitle":[{"text":"BleTransferMode","kind":"identifier"}]}}}
Loading

0 comments on commit a81e70d

Please sign in to comment.