Skip to content

Commit

Permalink
generate documentation with docc plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
phisakel committed Jul 3, 2024
1 parent 2c4e86a commit 69cde6e
Show file tree
Hide file tree
Showing 287 changed files with 683 additions and 0 deletions.
18 changes: 18 additions & 0 deletions Package.resolved
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,24 @@
"version" : "3.4.0"
}
},
{
"identity" : "swift-docc-plugin",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-plugin",
"state" : {
"revision" : "26ac5758409154cc448d7ab82389c520fa8a8247",
"version" : "1.3.0"
}
},
{
"identity" : "swift-docc-symbolkit",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-symbolkit",
"state" : {
"revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
"version" : "1.0.0"
}
},
{
"identity" : "swift-log",
"kind" : "remoteSourceControl",
Expand Down
1 change: 1 addition & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ let package = Package(
targets: ["MdocDataTransfer18013"]),
],
dependencies: [
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
.package(url: "https://github.com/eu-digital-identity-wallet/eudi-lib-ios-iso18013-data-model.git", .upToNextMajor(from: "0.2.6")),
.package(url: "https://github.com/eu-digital-identity-wallet/eudi-lib-ios-iso18013-security.git", .upToNextMajor(from: "0.2.1")),
],
Expand Down
9 changes: 9 additions & 0 deletions docs/css/523.e9a069b0.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/675.40c3bcb2.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic.b186e79f.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/index.ff036a9e.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/topic.672a9049.css

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/tutorials-overview.6eb589ed.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/data/documentation/mdocdatatransfer18013.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[[]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013"},"sections":[],"metadata":{"roleHeading":"Framework","symbolKind":"module","title":"MdocDataTransfer18013","role":"collection","externalID":"MdocDataTransfer18013","modules":[{"name":"MdocDataTransfer18013"}]},"topicSections":[{"title":"Classes","identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocGattServer","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocHelpers"]},{"identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocOfflineDelegate"],"title":"Protocols"},{"title":"Type Aliases","identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/RequestItems"]},{"title":"Enumerations","identifiers":["doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/ErrorCode","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/InitializeKeys","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocServiceCharacteristic","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/TransferStatus","doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/UserRequestKeys"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/mdocdatatransfer18013"]}],"references":{"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/UserRequestKeys":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserRequestKeys","kind":"identifier"}],"abstract":[{"text":"String keys for the user request dictionary","type":"text"}],"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/UserRequestKeys","navigatorTitle":[{"kind":"identifier","text":"UserRequestKeys"}],"type":"topic","url":"\/documentation\/mdocdatatransfer18013\/userrequestkeys","kind":"symbol","title":"UserRequestKeys","role":"symbol"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013":{"url":"\/documentation\/mdocdatatransfer18013","abstract":[],"type":"topic","role":"collection","title":"MdocDataTransfer18013","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013","kind":"symbol"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/InitializeKeys":{"url":"\/documentation\/mdocdatatransfer18013\/initializekeys","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"InitializeKeys"}],"title":"InitializeKeys","kind":"symbol","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/InitializeKeys","abstract":[{"type":"text","text":"String keys for the initialization dictionary"}],"navigatorTitle":[{"text":"InitializeKeys","kind":"identifier"}]},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/TransferStatus":{"abstract":[{"type":"text","text":"Transfer status enumeration"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"TransferStatus","kind":"identifier"}],"role":"symbol","title":"TransferStatus","navigatorTitle":[{"kind":"identifier","text":"TransferStatus"}],"url":"\/documentation\/mdocdatatransfer18013\/transferstatus","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/TransferStatus","type":"topic","kind":"symbol"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/BleTransferMode":{"role":"symbol","kind":"symbol","url":"\/documentation\/mdocdatatransfer18013\/bletransfermode","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/BleTransferMode","abstract":[{"text":"The enum BleTransferMode defines the two roles in the communication, which can be a server or a client.","type":"text"}],"type":"topic","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BleTransferMode"}],"navigatorTitle":[{"text":"BleTransferMode","kind":"identifier"}],"title":"BleTransferMode"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/RequestItems":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"RequestItems"}],"title":"RequestItems","abstract":[],"navigatorTitle":[{"text":"RequestItems","kind":"identifier"}],"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/RequestItems","role":"symbol","url":"\/documentation\/mdocdatatransfer18013\/requestitems","kind":"symbol","type":"topic"},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/MdocHelpers":{"identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocHelpers","navigatorTitle":[{"text":"MdocHelpers","kind":"identifier"}],"abstract":[{"type":"text","text":"Helper methods"}],"type":"topic","role":"symbol","url":"\/documentation\/mdocdatatransfer18013\/mdochelpers","title":"MdocHelpers","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"MdocHelpers","kind":"identifier"}]},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/MdocOfflineDelegate":{"navigatorTitle":[{"text":"MdocOfflineDelegate","kind":"identifier"}],"url":"\/documentation\/mdocdatatransfer18013\/mdocofflinedelegate","type":"topic","title":"MdocOfflineDelegate","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocOfflineDelegate","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"MdocOfflineDelegate","kind":"identifier"}],"abstract":[{"type":"text","text":"delegate protocol for clients of the mdoc offline transfer manager"}]},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/ErrorCode":{"abstract":[{"text":"Possible error codes","type":"text"}],"title":"ErrorCode","role":"symbol","type":"topic","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/ErrorCode","kind":"symbol","url":"\/documentation\/mdocdatatransfer18013\/errorcode","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ErrorCode","kind":"identifier"}],"navigatorTitle":[{"text":"ErrorCode","kind":"identifier"}]},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/MdocGattServer":{"type":"topic","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocGattServer","role":"symbol","url":"\/documentation\/mdocdatatransfer18013\/mdocgattserver","navigatorTitle":[{"kind":"identifier","text":"MdocGattServer"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"MdocGattServer","kind":"identifier"}],"title":"MdocGattServer","abstract":[{"text":"BLE Gatt server implementation of mdoc transfer manager","type":"text"}]},"doc://MdocDataTransfer18013/documentation/MdocDataTransfer18013/MdocServiceCharacteristic":{"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MdocServiceCharacteristic","kind":"identifier"}],"title":"MdocServiceCharacteristic","url":"\/documentation\/mdocdatatransfer18013\/mdocservicecharacteristic","abstract":[{"type":"text","text":"mdoc service characteristic definitions (mdoc is the GATT server)"}],"type":"topic","identifier":"doc:\/\/MdocDataTransfer18013\/documentation\/MdocDataTransfer18013\/MdocServiceCharacteristic","navigatorTitle":[{"kind":"identifier","text":"MdocServiceCharacteristic"}],"kind":"symbol"}}}
Loading

0 comments on commit 69cde6e

Please sign in to comment.