1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
# ``SymbolKit``
The specification and reference model for the *Symbol Graph* File Format.
## Overview
A *Symbol Graph* models a *module*, also known in various programming languages as a "framework", "library", or "package", as a [directed graph](https://en.wikipedia.org/wiki/Directed_graph). In this graph, the nodes are declarations, and the edges connecting nodes are relationships between declarations.
To illustrate the shape of a symbol graph, take the following Swift code as a module called `MyModule`:
```swift
public struct MyStruct {
public var x: Int
}
```
There are two nodes in this module's graph: the structure `MyStruct` and its property `x`:
`x` is related to `MyStruct`: it is a *member* of `MyStruct`. SymbolKit represents *relationships* as directed edges in the graph:
The *source* of an edge points to its *target*. You can read this edge as *`x` is a member of `MyStruct`*. Every edge is qualified by some kind of relationship; in this case, the kind is membership. There can be many kinds of relationships, even multiple relationships between the same two nodes. Here's another example, adding a Swift protocol to the mix:
```swift
public protocol P {}
public struct MyStruct: P {
public var x: Int
}
```
Now we've added a new node for the protocol `P`, and a new conformance relationship between `MyStruct` and `P`:
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.
## Topics
### Essentials
- ``SymbolGraph``
### Extending the Graph Structure
- <doc:GraphFormatExtensions>
<!-- Copyright (c) 2021-2022 Apple Inc and the Swift Project authors. All Rights Reserved. -->
|
