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
3.5 KiB
JSON
1 line
3.5 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"save"},{"kind":"text","text":"("},{"kind":"externalParam","text":"context"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSManagedObjectContext","preciseIdentifier":"c:objc(cs)NSManagedObjectContext"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"context","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"NSManagedObjectContext"},{"type":"text","text":" context instance to save."}]}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibspersistence\/service\/save(context:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Service\/save(context:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Save a given context."}],"kind":"symbol","metadata":{"role":"symbol","title":"save(context:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"save"},{"kind":"text","text":"("},{"kind":"externalParam","text":"context"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSManagedObjectContext","preciseIdentifier":"c:objc(cs)NSManagedObjectContext"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:20SwiftLibsPersistence7ServiceP4save7contextySo22NSManagedObjectContextC_tKF","required":true,"modules":[{"name":"SwiftLibsPersistence"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Service"]]},"references":{"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Service/save(context:)":{"role":"symbol","title":"save(context:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"save"},{"kind":"text","text":"("},{"kind":"externalParam","text":"context"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSManagedObjectContext","preciseIdentifier":"c:objc(cs)NSManagedObjectContext"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Save a given context."}],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Service\/save(context:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibspersistence\/service\/save(context:)"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence":{"role":"collection","title":"SwiftLibsPersistence","abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Service":{"role":"symbol","title":"Service","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Service"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Service","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Service"}],"url":"\/documentation\/swiftlibspersistence\/service"}}} |