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.
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
[SR-15414] DocC can't refer to Identifiable id
property
#209
Comments
Reproduced. Using the sample code below, and reference these property in DocC's Topics. A/id and C/description are fine. B/id and C/id are complaining -> "Topic reference 'B/id' couldn't be resolved to known documentation" public struct A {
public var id: String
}
public struct B: Identifiable {
public var id: String
}
public struct C: CustomStringConvertible, Identifiable {
public var id: String
public var description: String
} I'm investigating the code to find what's wrong. |
Xcode Version 13.3 (13E113) Probably related:
Breakdown
public struct Web3 {
}
extension Web3 {
public struct Utils {
}
}
extension Web3.Utils {
/// Note that this variable does have a documentation comment, but it's not resolved.
public static var erc20Abi = "some value here"
} But at the same time, this variable is resolved by Xcode and by Cmd+Click can navigate to the declaration source. |
All 3 examples in this thread work for me in the latest main and 5.9 builds of DocC. |
Feel free to reopen this issue and add more examples if there are cases where this doesn't work with the latest main or 5.9 builds of DocC. |
Additional Detail from JIRA
md5: c52b0f49f42bf64ff30b67f218f38502
Issue Description:
I noticed this in a more complicated situation, when I could not put my
id
property in my Topics section, to control where it appears. The following is a boiled down example. I includedCustomStringConvertible
anddescription
, because oddly DocC is fine with that one.The compiler does not like the
``id``
. It says:The rendered documentation has a nice link for
description
but not forid
.The text was updated successfully, but these errors were encountered: