Skip to content

Commit 54bb408

Browse files
committed
[SourceKit] Add a table of contents and format tweak
- Make the Demangle header match the other headers in the doc (e.g., double hash) - Add a table of contents that is sorted alphabetically by request key with a link to the header in the document
1 parent 9432de2 commit 54bb408

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

tools/SourceKit/docs/Protocol.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ The protocol is documented in the following format:
1616
- `"[opt]"` indicates an optional key.
1717
- Specific UIDs are written as `<UID string>`.
1818

19+
# Table of Contents
20+
21+
| Request Name | Request Key |
22+
| -------------:|:------------|
23+
| [Code Completion](#code-completion) | source.request.codecomplete |
24+
| [Cursor Info](#cursor-info) | source.request.cursorinfo |
25+
| [Demangling](#demangling) | source.request.demangle |
26+
| [Documentation](#documentation) | source.request.docinfo |
27+
| [Module interface generation](#module-interface-generation) | source.request.editor.open.interface |
28+
| [Indexing](#indexing) | source.request.indexsource |
29+
| [Protocol Version](#protocol-version) | source.request.protocol_version |
30+
1931

2032
# Requests
2133

@@ -393,7 +405,7 @@ range ::=
393405

394406
Sub-diagnostics are only diagnostic notes currently.
395407

396-
# Demangling
408+
## Demangling
397409

398410
SourceKit is capable of "demangling" mangled Swift symbols. In other words,
399411
it's capable of taking the symbol `_TF13MyCoolPackageg6raichuVS_7Pokemon` as

0 commit comments

Comments
 (0)