File: CustomMetadata.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (52 lines) | stat: -rw-r--r-- 1,547 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

import Foundation
public import Markdown

/// A directive that accepts an arbitrary key/value pair and emits it into the metadata of the page
///
/// It accepts following parameters:
///
/// key- a key to identify a piece of metadata
/// value- the value for the metadata
///
/// This directive is only valid within a ``Metadata`` directive:
/// ```
/// @Metadata {
///    @CustomMetadata(key: "country", value: "Belgium")
/// }
/// ```
public final class CustomMetadata: Semantic, AutomaticDirectiveConvertible {
    public static let introducedVersion = "5.8"
    public let originalMarkup: BlockDirective
    
    /// A key to identify a piece of metadata
    @DirectiveArgumentWrapped
    public var key: String
    
    /// value of the metadata
    @DirectiveArgumentWrapped
    public var value: String
    
    static var hiddenFromDocumentation = true
    
    static var keyPaths: [String : AnyKeyPath] = [
        "key" : \CustomMetadata._key,
        "value"  : \CustomMetadata._value,
    ]
    

    @available(*, deprecated, message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'.")
    init(originalMarkup: BlockDirective) {
        self.originalMarkup = originalMarkup
    }
}