6024e5c395
clang 20.0.0 (based on r547379) from build 12806354. Bug: http://b/379133546 Test: N/A Change-Id: I2eb8938af55d809de674be63cb30cf27e801862b Upstream-Commit: ad834e67b1105d15ef907f6255d4c96e8e733f57
55 lines
1.4 KiB
C++
55 lines
1.4 KiB
C++
//===--- CommentBriefParser.h - Dumb comment parser -------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines a very simple Doxygen comment parser.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
#ifndef LLVM_CLANG_AST_COMMENTBRIEFPARSER_H
|
|
#define LLVM_CLANG_AST_COMMENTBRIEFPARSER_H
|
|
|
|
#include "clang/AST/CommentLexer.h"
|
|
|
|
namespace clang {
|
|
namespace comments {
|
|
|
|
/// A very simple comment parser that extracts "a brief description".
|
|
///
|
|
/// Due to a variety of comment styles, it considers the following as "a brief
|
|
/// description", in order of priority:
|
|
/// \li a \or \\short command,
|
|
/// \li the first paragraph,
|
|
/// \li a \\result or \\return or \\returns paragraph.
|
|
class BriefParser {
|
|
Lexer &L;
|
|
|
|
const CommandTraits &Traits;
|
|
|
|
/// Current lookahead token.
|
|
Token Tok;
|
|
|
|
SourceLocation ConsumeToken() {
|
|
SourceLocation Loc = Tok.getLocation();
|
|
L.lex(Tok);
|
|
return Loc;
|
|
}
|
|
|
|
public:
|
|
BriefParser(Lexer &L, const CommandTraits &Traits);
|
|
|
|
/// Return the best "brief description" we can find.
|
|
std::string Parse();
|
|
};
|
|
|
|
} // end namespace comments
|
|
} // end namespace clang
|
|
|
|
#endif
|
|
|