Skip to content

Remove unused property and parameter from GeneratedDocumentationTopic code #1265

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

Merged
merged 2 commits into from
Aug 11, 2025
Merged

Remove unused property and parameter from GeneratedDocumentationTopic code #1265

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd633ad
Remove unused property and parameter from generated doc topic code
d-ronnqvist Jul 30, 2025
4818f33
Merge branch 'main' into remove-unused-doc-topic-code
d-ronnqvist Aug 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
15 changes: 6 additions & 9 deletions Sources/SwiftDocC/Infrastructure/Symbol Graph/GeneratedDocumentationTopics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift.org open source project

Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
Copyright (c) 2021-2025 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
Expand All @@ -27,8 +27,6 @@ enum GeneratedDocumentationTopics {
struct APICollection {
/// The title of the collection.
var title: String
/// A reference to the parent of the collection.
let parentReference: ResolvedTopicReference
/// A list of topic references for the collection.
var identifiers = [ResolvedTopicReference]()
}
Expand All @@ -39,8 +37,7 @@ enum GeneratedDocumentationTopics {
/// - childReference: The inherited symbol reference.
/// - reference: The parent type reference.
/// - originDisplayName: The origin display name as provided by the symbol graph.
/// - extendedModuleName: Extended module name.
mutating func add(_ childReference: ResolvedTopicReference, to reference: ResolvedTopicReference, childSymbol: SymbolGraph.Symbol, originDisplayName: String, originSymbol: SymbolGraph.Symbol?, extendedModuleName: String) throws {
mutating func add(_ childReference: ResolvedTopicReference, to reference: ResolvedTopicReference, childSymbol: SymbolGraph.Symbol, originDisplayName: String, originSymbol: SymbolGraph.Symbol?) throws {
let fromType: String
let typeSimpleName: String
if let originSymbol, originSymbol.pathComponents.count > 1 {
Expand Down Expand Up @@ -89,7 +86,7 @@ enum GeneratedDocumentationTopics {

// Create a new default implementations provider, if needed.
if !implementingTypes[reference]!.inheritedFromTypeName.keys.contains(fromType) {
implementingTypes[reference]!.inheritedFromTypeName[fromType] = Collections.APICollection(title: "\(typeSimpleName) Implementations", parentReference: reference)
implementingTypes[reference]!.inheritedFromTypeName[fromType] = Collections.APICollection(title: "\(typeSimpleName) Implementations")
}

// Add the default implementation.
Expand Down Expand Up @@ -247,13 +244,13 @@ enum GeneratedDocumentationTopics {
let child = context.documentationCache[relationship.source],
// Get the child symbol
let childSymbol = child.symbol,
// Get the swift extension data
let extends = childSymbol[mixin: SymbolGraph.Symbol.Swift.Extension.self]
// Check that there is Swift extension information
childSymbol[mixin: SymbolGraph.Symbol.Swift.Extension.self] != nil
{
let originSymbol = context.documentationCache[origin.identifier]?.symbol

// Add the inherited symbol to the index.
try inheritanceIndex.add(child.reference, to: parent.reference, childSymbol: childSymbol, originDisplayName: origin.displayName, originSymbol: originSymbol, extendedModuleName: extends.extendedModule)
try inheritanceIndex.add(child.reference, to: parent.reference, childSymbol: childSymbol, originDisplayName: origin.displayName, originSymbol: originSymbol)
}
}

Expand Down