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
5.0 KiB
JSON
1 line
5.0 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":" "},{"kind":"internalParam","text":"encoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Encoder","preciseIdentifier":"s:s7EncoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"encoder","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The encoder to use for the lossy encoding process."}]}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/lossycodablelist\/encode(to:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/encode(to:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Encodes an array of "},{"type":"codeVoice","code":"Element"},{"type":"text","text":" instances loosely."}],"kind":"symbol","metadata":{"conformance":{"constraints":[{"type":"codeVoice","code":"Element"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Encodable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"role":"symbol","title":"encode(to:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Encoder","preciseIdentifier":"s:s7EncoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:19SwiftLibsFoundation16LossyCodableListVAASERzlE6encode2toys7Encoder_p_tKF","extendedModule":"SwiftLibsFoundation","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/Encodable-Implementations"]]},"references":{"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"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/LossyCodableList/Encodable-Implementations":{"role":"collectionGroup","title":"Encodable Implementations","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/Encodable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftlibsfoundation\/lossycodablelist\/encodable-implementations"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/LossyCodableList/encode(to:)":{"conformance":{"constraints":[{"type":"codeVoice","code":"Element"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Encodable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"role":"symbol","title":"encode(to:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Encoder","preciseIdentifier":"s:s7EncoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Encodes an array of "},{"type":"codeVoice","code":"Element"},{"type":"text","text":" instances loosely."}],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/LossyCodableList\/encode(to:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/lossycodablelist\/encode(to:)"}}} |