Skip to content

Commit 1df2567

Browse files
committed
review: doxygen comment updates
1 parent a9d4d56 commit 1df2567

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

clang/include/clang/Parse/ParseHLSLRootSignature.h

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,14 @@ class RootSignatureParser {
115115
bool ParseDescriptorTable();
116116
bool ParseDescriptorTableClause();
117117

118-
// Helper dispatch method
119-
//
120-
// These will switch on the Variant kind to dispatch to the respective Parse
121-
// method and store the parsed value back into Ref.
122-
//
123-
// It is helpful to have a generalized dispatch method so that when we need
124-
// to parse multiple optional parameters in any order, we can invoke this
125-
// method
118+
/// Helper dispatch method
119+
///
120+
/// These will switch on the Variant kind to dispatch to the respective Parse
121+
/// method and store the parsed value back into Ref.
122+
///
123+
/// It is helpful to have a generalized dispatch method so that when we need
124+
/// to parse multiple optional parameters in any order, we can invoke this
125+
/// method
126126
bool ParseParam(llvm::hlsl::rootsig::ParamType Ref);
127127

128128
// Parse as many optional parameters as possible in any order
@@ -158,18 +158,18 @@ class RootSignatureParser {
158158
return false;
159159
}
160160

161-
// Attempt to retrieve the next token, if TokenKind is invalid then there was
162-
// no next token.
161+
/// Attempt to retrieve the next token, if TokenKind is invalid then there was
162+
/// no next token.
163163
RootSignatureToken PeekNextToken();
164164

165-
// Is the current token one of the expected kinds
165+
/// Is the current token one of the expected kinds
166166
bool EnsureExpectedToken(TokenKind AnyExpected);
167167
bool EnsureExpectedToken(ArrayRef<TokenKind> AnyExpected);
168168

169-
// Peek if the next token is of the expected kind.
170-
//
171-
// Return value denotes if it failed to match the expected kind, either it is
172-
// the end of the stream or it didn't match any of the expected kinds.
169+
/// Peek if the next token is of the expected kind.
170+
///
171+
/// Return value denotes if it failed to match the expected kind, either it is
172+
/// the end of the stream or it didn't match any of the expected kinds.
173173
bool PeekExpectedToken(TokenKind Expected);
174174
bool PeekExpectedToken(ArrayRef<TokenKind> AnyExpected);
175175

@@ -181,12 +181,12 @@ class RootSignatureParser {
181181
bool ConsumeExpectedToken(TokenKind Expected);
182182
bool ConsumeExpectedToken(ArrayRef<TokenKind> AnyExpected);
183183

184-
// Peek if the next token is of the expected kind and if it is then consume
185-
// it.
186-
//
187-
// Return value denotes if it failed to match the expected kind, either it is
188-
// the end of the stream or it didn't match any of the expected kinds. It will
189-
// not report an error if there isn't a match.
184+
/// Peek if the next token is of the expected kind and if it is then consume
185+
/// it.
186+
///
187+
/// Return value denotes if it failed to match the expected kind, either it is
188+
/// the end of the stream or it didn't match any of the expected kinds. It
189+
/// will not report an error if there isn't a match.
190190
bool TryConsumeExpectedToken(TokenKind Expected);
191191
bool TryConsumeExpectedToken(ArrayRef<TokenKind> Expected);
192192

0 commit comments

Comments
 (0)