Skip to content

Commit 910269d

Browse files
committed
Merge pull request #2455 from modocache/sourcekit-docs-test-candidate
[docs] Add SourceKit's `is_test_candidate`
2 parents 07b7e38 + 4e0358b commit 910269d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

tools/SourceKit/docs/Protocol.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,17 @@ that have already been returned.
136136
```
137137
entity ::=
138138
{
139-
<key.kind>: (UID) // UID for the declaration or reference kind (function, class, etc.).
140-
<key.name>: (string) // Displayed name for the entity.
141-
<key.usr>: (string) // USR string for the entity.
142-
<key.line>: (int64) // Line of the position of the entity in source contents.
143-
<key.column>: (int64) // Column of the position of the entity in source contents.
144-
[opt] <key.entities>: (array) [entity+] // One or more entities contained in the particular entity (sub-classes, references, etc.).
145-
[opt] <key.related>: (array) [entity+] // One or more entities related with the particular entity (inherited classes, protocols, etc.).
139+
<key.kind>: (UID) // UID for the declaration or reference kind (function, class, etc.).
140+
<key.name>: (string) // Displayed name for the entity.
141+
<key.usr>: (string) // USR string for the entity.
142+
<key.line>: (int64) // Line of the position of the entity in source contents.
143+
<key.column>: (int64) // Column of the position of the entity in source contents.
144+
[opt] <key.is_test_candidate> (bool) // Whether the instance method matches what XCTest considers
145+
// to be a viable test: a class instance method that takes no
146+
// parameters, returns void, and begins with "test". This key
147+
// is only present if the value is true.
148+
[opt] <key.entities>: (array) [entity+] // One or more entities contained in the particular entity (sub-classes, references, etc.).
149+
[opt] <key.related>: (array) [entity+] // One or more entities related with the particular entity (inherited classes, protocols, etc.).
146150
}
147151
```
148152

0 commit comments

Comments
 (0)