Skip to content

Commit cb9afaa

Browse files
committed
[IDE] Add doc comments for SignatureHelpResponse
1 parent 7dcc341 commit cb9afaa

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

tools/SourceKit/include/SourceKit/Core/LangSupport.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,22 +1014,39 @@ class ConformingMethodListConsumer {
10141014

10151015
struct SignatureHelpResponse {
10161016
struct Parameter {
1017+
/// The offset of the parameter text in the signature text.
10171018
unsigned Offset;
1019+
1020+
/// The length of the parameter text in the signature text.
10181021
unsigned Length;
1022+
1023+
/// The documentation comment for the parameter.
10191024
StringRef DocComment;
1025+
1026+
/// The internal parameter name.
10201027
StringRef Name;
10211028

10221029
Parameter() {}
10231030
};
10241031

10251032
struct Signature {
1033+
/// The text describing the signature.
10261034
StringRef Text;
1035+
1036+
/// The documentation comment for the signature.
10271037
StringRef Doc;
1038+
1039+
/// The index of the active parameter if any.
10281040
std::optional<unsigned> ActiveParam;
1041+
1042+
/// The parameters for the signature.
10291043
ArrayRef<Parameter> Params;
10301044
};
10311045

1046+
/// The index of the active signature.
10321047
unsigned ActiveSignature;
1048+
1049+
/// The available signatures/overloads.
10331050
ArrayRef<Signature> Signatures;
10341051
};
10351052

0 commit comments

Comments
 (0)