Update documentation

Author: ale-zai

docs/data/documentation/instruments.json

@@ -1 +1 @@
-{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bigEndian"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"bigEndian","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A value to use as the big-endian representation of the new number."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/instruments\/bytesconstructiblenumber\/init(bigendian:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bigEndian:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Creates a number from its big-endian representation, changing the byte order if"},{"type":"text","text":" "},{"type":"text","text":"necessary."}],"kind":"symbol","metadata":{"role":"symbol","title":"init(bigEndian:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bigEndian"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":")"}],"symbolKind":"init","externalID":"s:11Instruments24BytesConstructibleNumberP9bigEndianxx_tcfc","required":true,"modules":[{"name":"Instruments"}]},"hierarchy":{"paths":[["doc:\/\/Instruments\/documentation\/Instruments","doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber"]]},"references":{"doc://Instruments/documentation/Instruments/BytesConstructibleNumber/init(bigEndian:)":{"role":"symbol","title":"init(bigEndian:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bigEndian"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates a number from its big-endian representation, changing the byte order if"},{"type":"text","text":" "},{"type":"text","text":"necessary."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bigEndian:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/instruments\/bytesconstructiblenumber\/init(bigendian:)"},"doc://Instruments/documentation/Instruments/BytesConstructibleNumber":{"role":"symbol","title":"BytesConstructibleNumber","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"BytesConstructibleNumber"}],"abstract":[{"type":"text","text":"A protocol to which number should conform to be initialized from array of bytes and some"},{"type":"text","text":" "},{"type":"text","text":"endianness. The "},{"type":"codeVoice","code":"Instruments"},{"type":"text","text":" library makes all integer types to conform this protocol."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BytesConstructibleNumber"}],"url":"\/documentation\/instruments\/bytesconstructiblenumber"},"doc://Instruments/documentation/Instruments":{"role":"collection","title":"Instruments","abstract":[{"type":"emphasis","inlineContent":[{"type":"text","text":"Instruments"}]},{"type":"text","text":" is a package that provides you with set of tools that may be handy for Swift"},{"type":"text","text":" "},{"type":"text","text":"development."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments","kind":"symbol","type":"topic","url":"\/documentation\/instruments"}}}
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bigEndian"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"bigEndian","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A value to use as the big-endian representation of the new number."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/instruments\/bytesconstructiblenumber\/init(bigendian:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bigEndian:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Creates a number from its big-endian representation, changing the byte order if"},{"type":"text","text":" "},{"type":"text","text":"necessary."}],"kind":"symbol","metadata":{"role":"symbol","title":"init(bigEndian:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bigEndian"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":")"}],"symbolKind":"init","externalID":"s:11Instruments24BytesConstructibleNumberP9bigEndianxx_tcfc","required":true,"modules":[{"name":"Instruments"}]},"hierarchy":{"paths":[["doc:\/\/Instruments\/documentation\/Instruments","doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber"]]},"references":{"doc://Instruments/documentation/Instruments":{"role":"collection","title":"Instruments","abstract":[{"type":"emphasis","inlineContent":[{"type":"text","text":"Instruments"}]},{"type":"text","text":" is a package that provides you with set of tools that may be handy for Swift"},{"type":"text","text":" "},{"type":"text","text":"development."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments","kind":"symbol","type":"topic","url":"\/documentation\/instruments"},"doc://Instruments/documentation/Instruments/BytesConstructibleNumber":{"role":"symbol","title":"BytesConstructibleNumber","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"BytesConstructibleNumber"}],"abstract":[{"type":"text","text":"A protocol to which number should conform to be initialized from array of bytes and some"},{"type":"text","text":" "},{"type":"text","text":"endianness. The "},{"type":"codeVoice","code":"Instruments"},{"type":"text","text":" library makes all integer types to conform this protocol."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BytesConstructibleNumber"}],"url":"\/documentation\/instruments\/bytesconstructiblenumber"},"doc://Instruments/documentation/Instruments/BytesConstructibleNumber/init(bigEndian:)":{"role":"symbol","title":"init(bigEndian:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bigEndian"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates a number from its big-endian representation, changing the byte order if"},{"type":"text","text":" "},{"type":"text","text":"necessary."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bigEndian:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/instruments\/bytesconstructiblenumber\/init(bigendian:)"}}}

docs/data/documentation/instruments/bytesconstructiblenumber.json

@@ -1 +1 @@
-{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bytes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"UInt8","preciseIdentifier":"s:s5UInt8V"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"endianness"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Instruments\/documentation\/Instruments\/Endianness","preciseIdentifier":"s:11Instruments10EndiannessO","text":"Endianness"},{"kind":"text","text":" = .big)"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of bytes that will be used to initialize a number."}]}]},{"name":"endianness","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An endianness to be used to initialize a number. Defaults to "},{"type":"codeVoice","code":".big"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If number of bytes exceeds type size, it truncates bytes in the beginning or end depending"},{"type":"text","text":" "},{"type":"text","text":"on endianness. In case of BE it takes last "},{"type":"codeVoice","code":"MemoryLayout<Self>.size"},{"type":"text","text":" bytes, and in case of LE"},{"type":"text","text":" "},{"type":"text","text":"it takes first "},{"type":"codeVoice","code":"MemoryLayout<Self>.size"},{"type":"text","text":" bytes."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If number of bytes is less that "},{"type":"codeVoice","code":"MemoryLayout<Self>.size"},{"type":"text","text":", it adds zero bytes in the"},{"type":"text","text":" "},{"type":"text","text":"beginning or end depending on endianness. In case of BE it adds bytes in the beginning, and"},{"type":"text","text":" "},{"type":"text","text":"in case of LE it adds bytes in the end."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/instruments\/bytesconstructiblenumber\/init(bytes:endianness:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bytes:endianness:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Creates and returns a new instance of a number with a given parameters."}],"kind":"symbol","metadata":{"role":"symbol","title":"init(bytes:endianness:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bytes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"UInt8","preciseIdentifier":"s:s5UInt8V"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"endianness"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Endianness","preciseIdentifier":"s:11Instruments10EndiannessO"},{"kind":"text","text":")"}],"symbolKind":"init","externalID":"s:11Instruments24BytesConstructibleNumberPAAE5bytes10endiannessxSays5UInt8VG_AA10EndiannessOtcfc","extendedModule":"Instruments","modules":[{"name":"Instruments"}]},"hierarchy":{"paths":[["doc:\/\/Instruments\/documentation\/Instruments","doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber"]]},"references":{"doc://Instruments/documentation/Instruments/BytesConstructibleNumber":{"role":"symbol","title":"BytesConstructibleNumber","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"BytesConstructibleNumber"}],"abstract":[{"type":"text","text":"A protocol to which number should conform to be initialized from array of bytes and some"},{"type":"text","text":" "},{"type":"text","text":"endianness. The "},{"type":"codeVoice","code":"Instruments"},{"type":"text","text":" library makes all integer types to conform this protocol."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BytesConstructibleNumber"}],"url":"\/documentation\/instruments\/bytesconstructiblenumber"},"doc://Instruments/documentation/Instruments/BytesConstructibleNumber/init(bytes:endianness:)":{"role":"symbol","title":"init(bytes:endianness:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bytes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"UInt8","preciseIdentifier":"s:s5UInt8V"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"endianness"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Endianness","preciseIdentifier":"s:11Instruments10EndiannessO"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates and returns a new instance of a number with a given parameters."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bytes:endianness:)","kind":"symbol","type":"topic","url":"\/documentation\/instruments\/bytesconstructiblenumber\/init(bytes:endianness:)"},"doc://Instruments/documentation/Instruments":{"role":"collection","title":"Instruments","abstract":[{"type":"emphasis","inlineContent":[{"type":"text","text":"Instruments"}]},{"type":"text","text":" is a package that provides you with set of tools that may be handy for Swift"},{"type":"text","text":" "},{"type":"text","text":"development."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments","kind":"symbol","type":"topic","url":"\/documentation\/instruments"},"doc://Instruments/documentation/Instruments/Endianness":{"role":"symbol","title":"Endianness","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endianness"}],"abstract":[{"type":"text","text":"An order of bytes which can be either "},{"type":"codeVoice","code":"BE"},{"type":"text","text":" or "},{"type":"codeVoice","code":"LE"},{"type":"text","text":"."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/Endianness","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endianness"}],"url":"\/documentation\/instruments\/endianness"}}}
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bytes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"UInt8","preciseIdentifier":"s:s5UInt8V"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"endianness"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Instruments\/documentation\/Instruments\/Endianness","preciseIdentifier":"s:11Instruments10EndiannessO","text":"Endianness"},{"kind":"text","text":" = .big)"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of bytes that will be used to initialize a number."}]}]},{"name":"endianness","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An endianness to be used to initialize a number. Defaults to "},{"type":"codeVoice","code":".big"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If number of bytes exceeds type size, it truncates bytes in the beginning or end depending"},{"type":"text","text":" "},{"type":"text","text":"on endianness. In case of BE it takes last "},{"type":"codeVoice","code":"MemoryLayout<Self>.size"},{"type":"text","text":" bytes, and in case of LE"},{"type":"text","text":" "},{"type":"text","text":"it takes first "},{"type":"codeVoice","code":"MemoryLayout<Self>.size"},{"type":"text","text":" bytes."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If number of bytes is less that "},{"type":"codeVoice","code":"MemoryLayout<Self>.size"},{"type":"text","text":", it adds zero bytes in the"},{"type":"text","text":" "},{"type":"text","text":"beginning or end depending on endianness. In case of BE it adds bytes in the beginning, and"},{"type":"text","text":" "},{"type":"text","text":"in case of LE it adds bytes in the end."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/instruments\/bytesconstructiblenumber\/init(bytes:endianness:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bytes:endianness:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Creates and returns a new instance of a number with a given parameters."}],"kind":"symbol","metadata":{"role":"symbol","title":"init(bytes:endianness:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bytes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"UInt8","preciseIdentifier":"s:s5UInt8V"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"endianness"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Endianness","preciseIdentifier":"s:11Instruments10EndiannessO"},{"kind":"text","text":")"}],"symbolKind":"init","externalID":"s:11Instruments24BytesConstructibleNumberPAAE5bytes10endiannessxSays5UInt8VG_AA10EndiannessOtcfc","extendedModule":"Instruments","modules":[{"name":"Instruments"}]},"hierarchy":{"paths":[["doc:\/\/Instruments\/documentation\/Instruments","doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber"]]},"references":{"doc://Instruments/documentation/Instruments/BytesConstructibleNumber/init(bytes:endianness:)":{"role":"symbol","title":"init(bytes:endianness:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"bytes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"UInt8","preciseIdentifier":"s:s5UInt8V"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"endianness"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Endianness","preciseIdentifier":"s:11Instruments10EndiannessO"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates and returns a new instance of a number with a given parameters."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber\/init(bytes:endianness:)","kind":"symbol","type":"topic","url":"\/documentation\/instruments\/bytesconstructiblenumber\/init(bytes:endianness:)"},"doc://Instruments/documentation/Instruments/Endianness":{"role":"symbol","title":"Endianness","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endianness"}],"abstract":[{"type":"text","text":"An order of bytes which can be either "},{"type":"codeVoice","code":"BE"},{"type":"text","text":" or "},{"type":"codeVoice","code":"LE"},{"type":"text","text":"."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/Endianness","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endianness"}],"url":"\/documentation\/instruments\/endianness"},"doc://Instruments/documentation/Instruments/BytesConstructibleNumber":{"role":"symbol","title":"BytesConstructibleNumber","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"BytesConstructibleNumber"}],"abstract":[{"type":"text","text":"A protocol to which number should conform to be initialized from array of bytes and some"},{"type":"text","text":" "},{"type":"text","text":"endianness. The "},{"type":"codeVoice","code":"Instruments"},{"type":"text","text":" library makes all integer types to conform this protocol."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments\/BytesConstructibleNumber","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BytesConstructibleNumber"}],"url":"\/documentation\/instruments\/bytesconstructiblenumber"},"doc://Instruments/documentation/Instruments":{"role":"collection","title":"Instruments","abstract":[{"type":"emphasis","inlineContent":[{"type":"text","text":"Instruments"}]},{"type":"text","text":" is a package that provides you with set of tools that may be handy for Swift"},{"type":"text","text":" "},{"type":"text","text":"development."}],"identifier":"doc:\/\/Instruments\/documentation\/Instruments","kind":"symbol","type":"topic","url":"\/documentation\/instruments"}}}