Javier Cicchelli
f7235cdd28
This PR contains the work done to add DocC support to all the libraries included in this package, as requested by issue #9. To provide further details about the work done: - [x] added the DocC plugin package as a dependency - [x] improved the naming of the targets in the Package file - [x] updated the README file - [x] implemented the Xcode and Github pages documentation generation targets in the Makefile file - [x] generated both Xcode and Github pages documentation Reviewed-on: #23 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
2.9 KiB
JSON
1 line
2.9 KiB
JSON
{"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/lossycodablelist\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/Decodable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/init(from:)"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"SwiftLibsFoundation"}],"role":"collectionGroup","title":"Decodable Implementations"},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/LossyCodableList/init(from:)":{"conformance":{"constraints":[{"type":"codeVoice","code":"Element"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Decodable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Initialises the struct with a lossy decoder."}],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/lossycodablelist\/init(from:)"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation":{"role":"collection","title":"SwiftLibsFoundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/LossyCodableList":{"role":"symbol","title":"LossyCodableList","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"LossyCodableList"}],"abstract":[{"type":"text","text":"This struct (that could also be used as a property wrapper as well) provides a generic type that acts as a thin wrapper around an array of "},{"type":"codeVoice","code":"Elements"},{"type":"text","text":" instances to allow a lossy decoding and or encoding process."}],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LossyCodableList"}],"url":"\/documentation\/swiftlibsfoundation\/lossycodablelist"}}} |