The specification and reference model for the Symbol Graph File Format.
A Symbol Graph models a module, also known in various programming languages as a "framework", "library", or "package", as a directed graph. In this graph, the nodes are declarations, and the edges connecting nodes are relationships between declarations.
By modeling different kinds of relationships, SymbolKit can provide rich data to power documentation, answering interesting questions, such as:
- Which types conform to this protocol?
- What is the class hierarchy rooted at this class?
- Which protocol provides a requirement called
count? - Which types customize this protocol requirement?
In addition, graph representations of data also present opportunities for visualizations in documentation, illustrating the structure or hierarchy of a module.
Please see SymbolKit's documentation site for more detailed information about the library.
In your Package.swift Swift Package Manager manifest, add the following dependency to your dependencies argument:
.package(url: "https://github.com/apple/swift-docc-symbolkit.git", .branch("main")),Add the dependency to any targets you've declared in your manifest:
.target(name: "MyTarget", dependencies: ["SymbolKit"]),Contributions to SymbolKit are welcomed and encouraged! Please see the Contributing to Swift guide.
Before submitting the pull request, please make sure you have tested your changes and that they follow the Swift project guidelines for contributing code.
To be a truly great community, Swift.org needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make the Swift community welcoming to everyone.
To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and we think it articulates our values well. For more, see the Code of Conduct.