Update comments for lexer internal methods

Change-Id: I9ce36290dc054183db0746eafa821ca991e82885
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/70341
Auto-Submit: David Neto <dneto@google.com>
Kokoro: Kokoro <noreply+kokoro@google.com>
Reviewed-by: James Price <jrprice@google.com>
Commit-Queue: James Price <jrprice@google.com>
This commit is contained in:
David Neto 2021-11-19 21:04:45 +00:00 committed by Tint LUCI CQ
parent 0ff3050c6c
commit 0e2185efca

View File

@ -39,7 +39,7 @@ class Lexer {
private:
/// Advances past whitespace and comments, if present
/// at the current position.
/// @returns uninitialized token on success, or error
/// @returns error token, EOF, or uninitialized
Token skip_whitespace_and_comments();
/// Advances past a comment at the current position,
/// if one exists.
@ -51,6 +51,15 @@ class Lexer {
size_t end,
int32_t base);
Token check_keyword(const Source&, const std::string&);
/// The try_* methods have the following in common:
/// - They assume there is at least one character to be consumed,
/// i.e. the input has not yet reached end of file.
/// - They return an initialized token when they match and consume
/// a token of the specified kind.
/// - Some can return an error token.
/// - Otherwise they return an uninitialized token when they did not
/// match a token of the specfied kind.
Token try_float();
Token try_hex_float();
Token try_hex_integer();