Skip to content

Commit 5ce10d1

Browse files
Merge pull request #27548 from varungandhi-apple/vg-document-USR
[NFC] Add a short note on what USRs are and what they're used for.
2 parents dfe962f + ca7e809 commit 5ce10d1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

include/swift/AST/USRGeneration.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
1010
//
1111
//===----------------------------------------------------------------------===//
12+
//
13+
// Unique Symbol References (USRs) provide a textual encoding for
14+
// declarations. These are used for indexing, analogous to how mangled names
15+
// are used in object files.
16+
//
17+
//===----------------------------------------------------------------------===//
1218

1319
#ifndef SWIFT_AST_USRGENERATION_H
1420
#define SWIFT_AST_USRGENERATION_H

0 commit comments

Comments
 (0)