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
3.5 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/foundation\/bundle"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation\/Bundle","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation\/Bundle\/localisation(for:)"]}],"kind":"symbol","metadata":{"navigatorTitle":[{"kind":"identifier","text":"Bundle"}],"role":"symbol","title":"Bundle","roleHeading":"Extended Class","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"}],"symbolKind":"extension","externalID":"s:e:s:So8NSBundleC19SwiftLibsFoundationE12localisation3forABSS_tKF","extendedModule":"Foundation","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/Foundation":{"role":"collection","title":"Foundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/foundation"},"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/Foundation/Bundle/localisation(for:)":{"role":"symbol","title":"localisation(for:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"localisation"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"}],"abstract":[{"type":"text","text":"Retrieve a localisation bundle for a given language code or identifier, if exist inside a certain bundle."}],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation\/Bundle\/localisation(for:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/foundation\/bundle\/localisation(for:)"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/Foundation/Bundle":{"role":"symbol","title":"Bundle","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation\/Bundle","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Bundle"}],"url":"\/documentation\/swiftlibsfoundation\/foundation\/bundle"}}}