Merge pull request #607 from NordicSemiconductor/documentation

Documentation regenerated

Library/Documentation.docc/LocalNode.md

@@ -58,7 +58,7 @@ address.
   i.e. not bound to any key, or not subscribed to the address set as destination address of the 
   message.
 
-> See `Example/nRFMeshProvision/AppDelegate.swift` in "nRF Mesh" sample app for an example.
+> See `Example/Source/AppDelegate.swift` in "nRF Mesh" sample app for an example.
 
 ## What's next
 

Library/Type Extensions/Task+TimeInterval.swift

@@ -1,9 +1,32 @@
-//
-//  Task+TimeInterval.swift
-//  nRFMeshProvision
-//
-//  Created by Aleksander Nowakowski on 15.09.2023.
-//
+/*
+* Copyright (c) 2019, Nordic Semiconductor
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without modification,
+* are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice, this
+*    list of conditions and the following disclaimer in the documentation and/or
+*    other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its contributors may
+*    be used to endorse or promote products derived from this software without
+*    specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+* POSSIBILITY OF SUCH DAMAGE.
+*/
 
 import Foundation
 

README.md

@@ -56,7 +56,7 @@ The following features are not (yet) supported:
 
 The library is available using CocoaPods, SPM and Carthage. For details, check out [Setting up the library](SETTING_UP.md).
 
-Product documentation is available here: [Documentation](https://nordicsemiconductor.github.io/IOS-nRF-Mesh-Library/documentation/nrfmeshprovision).
+Product documentation is available here: [Documentation](https://nordicsemiconductor.github.io/IOS-nRF-Mesh-Library/documentation/nordicmesh).
 
 ## nRF Mesh sample app
 

docs/data/documentation/nordicmesh/+(_:_:)-4vt5d.json

@@ -0,0 +1 @@
+{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/nordicmesh\/+(_:_:)-4vt5d"]}],"hierarchy":{"paths":[["doc:\/\/NordicMesh\/documentation\/NordicMesh"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-4vt5d"},"sections":[],"metadata":{"role":"symbol","modules":[{"name":"NordicMesh"}],"roleHeading":"Operator","title":"+(_:_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"+","kind":"identifier"},{"text":" ","kind":"text"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:10NordicMesh12AddressRangeC","text":"AddressRange","kind":"typeIdentifier"},{"text":"], [","kind":"text"},{"text":"AddressRange","kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh12AddressRangeC"},{"kind":"text","text":"]) -> ["},{"preciseIdentifier":"s:10NordicMesh12AddressRangeC","text":"AddressRange","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"externalID":"s:10NordicMesh1poiySayAA12AddressRangeCGAE_AEtF","symbolKind":"op"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"+"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"array","kind":"internalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"AddressRange","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/AddressRange","preciseIdentifier":"s:10NordicMesh12AddressRangeC"},{"kind":"text","text":"], "},{"text":"otherArray","kind":"internalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:10NordicMesh12AddressRangeC","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/AddressRange","kind":"typeIdentifier","text":"AddressRange"},{"kind":"text","text":"]) -> ["},{"text":"AddressRange","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/AddressRange","kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh12AddressRangeC"},{"text":"]","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]}],"references":{"doc://NordicMesh/documentation/NordicMesh/+(_:_:)-4vt5d":{"abstract":[],"type":"topic","title":"+(_:_:)","url":"\/documentation\/nordicmesh\/+(_:_:)-4vt5d","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"+","kind":"identifier"},{"kind":"text","text":" "},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh12AddressRangeC","text":"AddressRange"},{"text":"], [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh12AddressRangeC","text":"AddressRange"},{"kind":"text","text":"]) -> ["},{"preciseIdentifier":"s:10NordicMesh12AddressRangeC","kind":"typeIdentifier","text":"AddressRange"},{"text":"]","kind":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-4vt5d"},"doc://NordicMesh/documentation/NordicMesh":{"title":"NordicMesh","kind":"symbol","role":"collection","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh","abstract":[{"text":"Provision, configure and control Bluetooth mesh devices with nRF Mesh library.","type":"text"}],"type":"topic","url":"\/documentation\/nordicmesh"},"doc://NordicMesh/documentation/NordicMesh/AddressRange":{"type":"topic","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"AddressRange","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"AddressRange","kind":"identifier"}],"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/AddressRange","role":"symbol","url":"\/documentation\/nordicmesh\/addressrange","abstract":[{"text":"The range of addresses of Unicast or Group type.","type":"text"}],"title":"AddressRange"}}}

docs/data/documentation/nordicmesh/+(_:_:)-8gjad.json

@@ -0,0 +1 @@
+{"kind":"symbol","identifier":{"url":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-8gjad","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"+","kind":"identifier"},{"kind":"text","text":" "},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"text":"left","kind":"internalParam"},{"kind":"text","text":": "},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"right"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"T"},{"text":") -> [","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":"] ","kind":"text"},{"kind":"keyword","text":"where"},{"kind":"text","text":" "},{"text":"T","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:10NordicMesh11RangeObjectC","kind":"typeIdentifier","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/RangeObject","text":"RangeObject"}],"platforms":["macOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/nordicmesh\/+(_:_:)-8gjad"]}],"sections":[],"metadata":{"modules":[{"name":"NordicMesh"}],"symbolKind":"op","title":"+(_:_:)","externalID":"s:10NordicMesh1poiySayxGx_xtAA11RangeObjectCRbzlF","roleHeading":"Operator","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"+","kind":"identifier"},{"kind":"text","text":" "},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":">("},{"kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"text":") -> [","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":"]","kind":"text"}]},"hierarchy":{"paths":[["doc:\/\/NordicMesh\/documentation\/NordicMesh"]]},"references":{"doc://NordicMesh/documentation/NordicMesh/RangeObject":{"role":"symbol","title":"RangeObject","abstract":[{"type":"text","text":"A base class for an address or scene range."}],"url":"\/documentation\/nordicmesh\/rangeobject","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RangeObject","kind":"identifier"}],"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/RangeObject","type":"topic","navigatorTitle":[{"kind":"identifier","text":"RangeObject"}]},"doc://NordicMesh/documentation/NordicMesh/+(_:_:)-8gjad":{"type":"topic","url":"\/documentation\/nordicmesh\/+(_:_:)-8gjad","kind":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"+","kind":"identifier"},{"text":" ","kind":"text"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"text":">(","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"T"},{"text":"]","kind":"text"}],"role":"symbol","title":"+(_:_:)","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-8gjad"},"doc://NordicMesh/documentation/NordicMesh":{"title":"NordicMesh","kind":"symbol","role":"collection","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh","abstract":[{"text":"Provision, configure and control Bluetooth mesh devices with nRF Mesh library.","type":"text"}],"type":"topic","url":"\/documentation\/nordicmesh"}}}

docs/data/documentation/nordicmesh/+(_:_:)-8nkup.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"+"},{"text":" ","kind":"text"},{"kind":"text","text":"<"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":">("},{"text":"array","kind":"internalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"text":"], ","kind":"text"},{"kind":"internalParam","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"T"},{"text":") -> [","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":"] "},{"text":"where","kind":"keyword"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":" : "},{"text":"RangeObject","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/RangeObject","kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh11RangeObjectC"}],"languages":["swift"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/NordicMesh\/documentation\/NordicMesh"]]},"sections":[],"metadata":{"modules":[{"name":"NordicMesh"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"+"},{"kind":"text","text":" "},{"kind":"text","text":"<"},{"text":"T","kind":"genericParameter"},{"text":">([","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":"], "},{"text":"T","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"symbolKind":"op","externalID":"s:10NordicMesh1poiySayxGAC_xtAA11RangeObjectCRbzlF","title":"+(_:_:)","roleHeading":"Operator","role":"symbol"},"identifier":{"url":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-8nkup","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/nordicmesh\/+(_:_:)-8nkup"]}],"references":{"doc://NordicMesh/documentation/NordicMesh/+(_:_:)-8nkup":{"title":"+(_:_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"+","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"text":">([","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"text":"]","kind":"text"}],"url":"\/documentation\/nordicmesh\/+(_:_:)-8nkup","type":"topic","role":"symbol","kind":"symbol","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-8nkup","abstract":[]},"doc://NordicMesh/documentation/NordicMesh":{"title":"NordicMesh","kind":"symbol","role":"collection","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh","abstract":[{"text":"Provision, configure and control Bluetooth mesh devices with nRF Mesh library.","type":"text"}],"type":"topic","url":"\/documentation\/nordicmesh"},"doc://NordicMesh/documentation/NordicMesh/RangeObject":{"role":"symbol","title":"RangeObject","abstract":[{"type":"text","text":"A base class for an address or scene range."}],"url":"\/documentation\/nordicmesh\/rangeobject","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RangeObject","kind":"identifier"}],"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/RangeObject","type":"topic","navigatorTitle":[{"kind":"identifier","text":"RangeObject"}]}}}

docs/data/documentation/nordicmesh/+(_:_:)-rqfz.json

@@ -0,0 +1 @@
+{"hierarchy":{"paths":[["doc:\/\/NordicMesh\/documentation\/NordicMesh"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-rqfz"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/nordicmesh\/+(_:_:)-rqfz"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Operator","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"+","kind":"identifier"},{"text":" ","kind":"text"},{"text":"([","kind":"text"},{"text":"SceneRange","preciseIdentifier":"s:10NordicMesh10SceneRangeC","kind":"typeIdentifier"},{"text":"], [","kind":"text"},{"preciseIdentifier":"s:10NordicMesh10SceneRangeC","text":"SceneRange","kind":"typeIdentifier"},{"text":"]) -> [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh10SceneRangeC","text":"SceneRange"},{"kind":"text","text":"]"}],"symbolKind":"op","role":"symbol","modules":[{"name":"NordicMesh"}],"externalID":"s:10NordicMesh1poiySayAA10SceneRangeCGAE_AEtF","title":"+(_:_:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"+","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"internalParam","text":"array"},{"kind":"text","text":": ["},{"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/SceneRange","preciseIdentifier":"s:10NordicMesh10SceneRangeC","text":"SceneRange","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"otherArray","kind":"internalParam"},{"kind":"text","text":": ["},{"text":"SceneRange","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/SceneRange","kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh10SceneRangeC"},{"text":"]) -> [","kind":"text"},{"kind":"typeIdentifier","text":"SceneRange","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/SceneRange","preciseIdentifier":"s:10NordicMesh10SceneRangeC"},{"kind":"text","text":"]"}],"languages":["swift"]}]}],"kind":"symbol","references":{"doc://NordicMesh/documentation/NordicMesh/Provisioner":{"url":"\/documentation\/nordicmesh\/provisioner","title":"Provisioner","role":"symbol","abstract":[{"text":"Representation of a Provisioner in the mesh network.","type":"text"}],"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/Provisioner","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Provisioner","kind":"identifier"}],"type":"topic","kind":"symbol","navigatorTitle":[{"text":"Provisioner","kind":"identifier"}]},"doc://NordicMesh/documentation/NordicMesh/SceneRange":{"abstract":[{"type":"text","text":"The range of "},{"type":"reference","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/SceneNumber","isActive":true},{"text":"s assigned to a ","type":"text"},{"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/Provisioner","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/nordicmesh\/scenerange","title":"SceneRange","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"SceneRange"}],"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/SceneRange","navigatorTitle":[{"text":"SceneRange","kind":"identifier"}],"type":"topic"},"doc://NordicMesh/documentation/NordicMesh":{"title":"NordicMesh","kind":"symbol","role":"collection","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh","abstract":[{"text":"Provision, configure and control Bluetooth mesh devices with nRF Mesh library.","type":"text"}],"type":"topic","url":"\/documentation\/nordicmesh"},"doc://NordicMesh/documentation/NordicMesh/+(_:_:)-rqfz":{"type":"topic","url":"\/documentation\/nordicmesh\/+(_:_:)-rqfz","kind":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"+","kind":"identifier"},{"text":" ","kind":"text"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh10SceneRangeC","text":"SceneRange"},{"text":"], [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10NordicMesh10SceneRangeC","text":"SceneRange"},{"kind":"text","text":"]) -> ["},{"preciseIdentifier":"s:10NordicMesh10SceneRangeC","text":"SceneRange","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"role":"symbol","title":"+(_:_:)","identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/+(_:_:)-rqfz"},"doc://NordicMesh/documentation/NordicMesh/SceneNumber":{"kind":"symbol","abstract":[{"text":"Scene number type. Type alias for UInt16.","type":"text"}],"url":"\/documentation\/nordicmesh\/scenenumber","title":"SceneNumber","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"SceneNumber","kind":"identifier"}],"identifier":"doc:\/\/NordicMesh\/documentation\/NordicMesh\/SceneNumber","navigatorTitle":[{"text":"SceneNumber","kind":"identifier"}],"type":"topic"}}}