Skip to content

Add a public initializer to RenderContentMetadata #1337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add a public initializer to RenderContentMetadata #1337

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
250486a
Add a public initializer to RenderContentMetadata
patshaughnessy Nov 7, 2025
ef63229
Update Sources/SwiftDocC/Model/Rendering/Content/RenderContentMetadat…
patshaughnessy Nov 7, 2025
c587ac9
Introduce PublicAPITests for verifying certain API are actually public.
patshaughnessy Nov 7, 2025
dae3e09
Merge branch 'main' into r164210651-add-public-initializer-RenderCont…
patshaughnessy Nov 11, 2025
d1d964a
Remove unneeded unit test in PublicAPITests.swift.
patshaughnessy Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Sources/SwiftDocC/Model/Rendering/Content/RenderContentMetadata.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ public struct RenderContentMetadata: Equatable, Codable {
public var abstract: [RenderInlineContent]?
/// An optional identifier for the device frame that should wrap this element.
public var deviceFrame: String?

/// Creates a new metadata value for a content element.
/// - Parameters:
/// - anchor: The named anchor of the content element.
/// - title: The customized title for the content element.
/// - abstract: The customized abstract for the content element.
/// - deviceFrame: The identifier for the device frame that should wrap the content element.
public init(anchor: String? = nil, title: String? = nil, abstract: [RenderInlineContent]? = nil, deviceFrame: String? = nil) {
self.anchor = anchor
self.title = title
self.abstract = abstract
self.deviceFrame = deviceFrame
}
}

extension RenderContentMetadata {
Expand Down