Skip to content

Commit 13e5c91

Browse files
author
Finn Plummer
committed
self-review: fix up comment
1 parent decaace commit 13e5c91

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

clang/include/clang/Parse/ParseHLSLRootSignature.h

+24-13
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,30 @@ class RootSignatureParser {
4040
private:
4141
DiagnosticsEngine &Diags() { return PP.getDiagnostics(); }
4242

43-
/// All private Parse.* methods follow a similar pattern:
44-
/// - Each method will start with an assert to denote what the CurToken is
45-
/// expected to be and will parse from that token forward
46-
/// - Therefore, it is the callers responsibility to ensure that you are
47-
/// at the correct CurToken. This should be done with the pattern of:
48-
/// if (TryConsumeExpectedToken(TokenKind)
49-
/// if (Parse.*())
50-
/// return true;
51-
/// - All methods return true if a parsing error is encountered. It is the
52-
/// callers responsibility to propogate this error up, or deal with it
53-
/// otherwise
54-
/// - An error will be raised if the proceeding tokens are not what is
55-
/// expected, or, there is a lexing error
43+
// All private Parse.* methods follow a similar pattern:
44+
// - Each method will start with an assert to denote what the CurToken is
45+
// expected to be and will parse from that token forward
46+
//
47+
// - Therefore, it is the callers responsibility to ensure that you are
48+
// at the correct CurToken. This should be done with the pattern of:
49+
//
50+
// if (TryConsumeExpectedToken(TokenKind))
51+
// if (Parse.*())
52+
// return true;
53+
//
54+
// or,
55+
//
56+
// if (ConsumeExpectedToken(TokenKind, ...))
57+
// return true;
58+
// if (Parse.*())
59+
// return true;
60+
//
61+
// - All methods return true if a parsing error is encountered. It is the
62+
// callers responsibility to propogate this error up, or deal with it
63+
// otherwise
64+
//
65+
// - An error will be raised if the proceeding tokens are not what is
66+
// expected, or, there is a lexing error
5667

5768
/// Root Element parse methods:
5869
bool ParseDescriptorTable();

0 commit comments

Comments
 (0)