57 lines
1.4 KiB
C
57 lines
1.4 KiB
C
|
//===--- CommentBriefParser.h - Dumb comment parser -------------*- C++ -*-===//
|
||
|
|
//
|
||
|
|
// The LLVM Compiler Infrastructure
|
||
|
|
//
|
||
|
|
// This file is distributed under the University of Illinois Open Source
|
||
|
|
// License. See LICENSE.TXT for details.
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
//
|
||
|
|
// This file defines a very simple Doxygen comment parser.
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef LLVM_CLANG_AST_BRIEF_COMMENT_PARSER_H
|
||
|
|
#define LLVM_CLANG_AST_BRIEF_COMMENT_PARSER_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 \\brief 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 \\brief paragraph, if it exists; otherwise return the first
|
||
|
|
/// paragraph.
|
||
|
|
std::string Parse();
|
||
|
|
};
|
||
|
|
|
||
|
|
} // end namespace comments
|
||
|
|
} // end namespace clang
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|