Javier Cicchelli f7235cdd28 [Enhancement] DocC documentation support (#23)
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>
2023-08-13 22:01:00 +00:00

1 line
7.8 KiB
JSON

{"interfaceLanguages":{"swift":[{"children":[{"title":"Classes","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/init(fetchrequest:managedobjectcontext:sectionnamekeypath:cachename:)","title":"init(fetchRequest: NSFetchRequest<Model>, managedObjectContext: NSManagedObjectContext, sectionNameKeyPath: String?, cacheName: String?)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/didchangepublisher","title":"let didChangePublisher: PassthroughSubject<[Change], Never>","type":"property"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/numberofsections","title":"var numberOfSections: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/controller(_:didchange:at:for:newindexpath:)","title":"func controller(NSFetchedResultsController<NSFetchRequestResult>, didChange: Any, at: IndexPath?, for: NSFetchedResultsChangeType, newIndexPath: IndexPath?)","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/controller(_:didchange:atsectionindex:for:)","title":"func controller(NSFetchedResultsController<NSFetchRequestResult>, didChange: NSFetchedResultsSectionInfo, atSectionIndex: Int, for: NSFetchedResultsChangeType)","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/controllerdidchangecontent(_:)","title":"func controllerDidChangeContent(NSFetchedResultsController<NSFetchRequestResult>)","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/controllerwillchangecontent(_:)","title":"func controllerWillChangeContent(NSFetchedResultsController<NSFetchRequestResult>)","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/fetch()","title":"func fetch() throws","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/numberofobjects(in:)","title":"func numberOfObjects(in: Int) throws -> Int","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/fetcher\/object(at:)","title":"func object(at: IndexPath) throws -> Model","type":"method"}],"path":"\/documentation\/swiftlibspersistence\/fetcher","title":"Fetcher","type":"class"},{"title":"Protocols","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/service\/viewcontext","title":"var viewContext: NSManagedObjectContext","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/service\/makechildcontext()","title":"func makeChildContext() -> NSManagedObjectContext","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/service\/maketaskcontext()","title":"func makeTaskContext() -> NSManagedObjectContext","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/service\/save(childcontext:)","title":"func save(childContext: NSManagedObjectContext) throws","type":"method"},{"path":"\/documentation\/swiftlibspersistence\/service\/save(context:)","title":"func save(context: NSManagedObjectContext) throws","type":"method"}],"path":"\/documentation\/swiftlibspersistence\/service","title":"Service","type":"protocol"},{"title":"Enumerations","type":"groupMarker"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/change\/object(_:)","title":"case object(Change.ObjectUpdate)","type":"case"},{"path":"\/documentation\/swiftlibspersistence\/change\/section(_:)","title":"case section(Change.SectionUpdate)","type":"case"},{"title":"Enumerations","type":"groupMarker"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate\/deleted(from:)","title":"case deleted(from: IndexPath)","type":"case"},{"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate\/inserted(at:)","title":"case inserted(at: IndexPath)","type":"case"},{"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate\/moved(from:to:)","title":"case moved(from: IndexPath, to: IndexPath)","type":"case"},{"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate\/updated(at:)","title":"case updated(at: IndexPath)","type":"case"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibspersistence\/change\/objectupdate","title":"Change.ObjectUpdate","type":"enum"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/deleted(_:)","title":"case deleted(Int)","type":"case"},{"path":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/inserted(_:)","title":"case inserted(Int)","type":"case"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibspersistence\/change\/sectionupdate","title":"Change.SectionUpdate","type":"enum"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/change\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibspersistence\/change\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibspersistence\/change","title":"Change","type":"enum"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/fetchererror\/fetchnotexecuted","title":"case fetchNotExecuted","type":"case"},{"path":"\/documentation\/swiftlibspersistence\/fetchererror\/sectionnotfound","title":"case sectionNotFound","type":"case"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/fetchererror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibspersistence\/fetchererror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/fetchererror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/swiftlibspersistence\/fetchererror\/error-implementations","title":"Error Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibspersistence\/fetchererror","title":"FetcherError","type":"enum"},{"title":"Extended Modules","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibspersistence\/foundation\/url\/bitbucket","title":"static let bitBucket: URL","type":"property"}],"path":"\/documentation\/swiftlibspersistence\/foundation\/url","title":"URL","type":"extension"}],"path":"\/documentation\/swiftlibspersistence\/foundation","title":"Foundation","type":"extension"}],"path":"\/documentation\/swiftlibspersistence","title":"SwiftLibsPersistence","type":"module"}]},"schemaVersion":{"major":0,"minor":1,"patch":1}}