Comments (4)
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.
from swift-docc.
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.
from swift-docc.
Xcode Version 13.3 (13E113)
Probably related:
Topic reference 'Web3/Utils/erc20ABI' couldn't be resolved. No local documentation matches this reference.
Breakdown
erc20ABI
is a public static var
declared in an extension of Web3.Utils
which is a struct
.
The Web3.Utils
is declared in an extension.
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.
from swift-docc.
All 3 examples in this thread work for me in the latest main and 5.9 builds of DocC.
from swift-docc.
Related Issues (20)
- Swift-DocC should display C++ and Objective-C++ as their own source languages
- source link line number mismatch HOT 2
- Support svg images in Xcode inline documentation HOT 2
- Pass "link summaries" instead of "resolved information" in external documentation source responses
- Can't document - -= / /= operators HOT 8
- DocC generates inconsistent output for global Objective-C functions that are renamed to be associated with a type in Swift HOT 2
- Error when publishing to GitHub Pages HOT 6
- Linkable glossary
- Document Objective-C extensions with DocC HOT 2
- Xcode "Build documentation" not working with Swift Macro package in project HOT 5
- Curating a module under a technology root causes the sidebar to not show Objective-C symbols
- illegal hardware instruction HOT 4
- This mangled quote/code fence results in a crash HOT 1
- `@DeprecationSummary` directive doesn't always have an effect HOT 2
- Xcode does not provide fix for operator functions HOT 4
- Make DocC-Generated Website Indexable by Search Engines HOT 2
- Slices of Snippets don't have indentation removed HOT 1
- optional force unwrap fails if target name contains special characters
- Snippet slicing does not handle multiline string literals correctly
- Migrate to Swift 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swift-docc.