Javier Cicchelli
18d68635ce
This PR contains the work done to fix the Github Pages generated documentation, as the assigned base path and documentation URL were not properly defined. Reviewed-on: #24 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
5.1 KiB
JSON
1 line
5.1 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"localisation"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":" "},{"kind":"internalParam","text":"languageCode"},{"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"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"languageCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A string that represent a language code or identifier."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"Bundle"},{"type":"text","text":" instance that contains localised resources based on a given language code or identifier."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"BundleError"},{"type":"text","text":" error in case the localisation bundle for a given language code or identifier is not found inside a certain bundle."}]}],"type":"aside","name":"Throws"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/foundation\/bundle\/localisation(for:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation\/Bundle\/localisation(for:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Retrieve a localisation bundle for a given language code or identifier, if exist inside a certain bundle."}],"kind":"symbol","metadata":{"role":"symbol","title":"localisation(for:)","roleHeading":"Instance Method","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"}],"symbolKind":"method","externalID":"s:So8NSBundleC19SwiftLibsFoundationE12localisation3forABSS_tKF","extendedModule":"Foundation","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Foundation\/Bundle"]]},"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":{"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"},"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:)"}}} |