rock-n-code/swift-libs
rock-n-code/swift-libs
1
0
Fork 0
Code Issues 1 Pull Requests Releases 13 Wiki Activity
swift-libs/docs/swift-libs-foundation/data/documentation/swiftlibsfoundation/swift/string/localise(for:in:value:table:).json
Javier Cicchelli 18d68635ce [Improvement] Github Pages documentation (#24) 
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>
2023-08-13 22:30:56 +00:00

1 line
6.6 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"localise"},{"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":"externalParam","text":"in"},{"kind":"text","text":" "},{"kind":"internalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":", "},{"kind":"externalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"table"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"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."}]}]},{"name":"bundle","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A bundle in which to retrieve a localisation bundle."}]}]},{"name":"value","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A default value to return if key is nil or if a localized string for key can’t be found in the table."}]}]},{"name":"table","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The receiver’s string table to search. In case of nil or an empty string, the method attempts to use the table in "},{"type":"codeVoice","code":"Localizable.strings"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A localized version of the string in case it is found. Otherwise, it returns the original string or a default string, if provided."}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/swift\/string\/localise(for:in:value:table:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Swift\/String\/localise(for:in:value:table:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Localise a string based on a given language code or identifier in an specific bundle."}],"kind":"symbol","metadata":{"role":"symbol","title":"localise(for:in:value:table:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"localise"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"in"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":", "},{"kind":"externalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"table"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"method","externalID":"s:SS19SwiftLibsFoundationE8localise3for2in5value5tableS2S_So8NSBundleCSSSgAItF","extendedModule":"Swift","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Swift","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Swift\/String"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/Swift":{"role":"collection","title":"Swift","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Swift","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/swift"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/Swift/String":{"role":"symbol","title":"String","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Swift\/String","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"String"}],"url":"\/documentation\/swiftlibsfoundation\/swift\/string"},"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/Swift/String/localise(for:in:value:table:)":{"role":"symbol","title":"localise(for:in:value:table:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"localise"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"in"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":", "},{"kind":"externalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"table"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Localise a string based on a given language code or identifier in an specific bundle."}],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/Swift\/String\/localise(for:in:value:table:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/swift\/string\/localise(for:in:value:table:)"}}}
Reference in New Issue View Git Blame Copy Permalink