summaryrefslogtreecommitdiffstats
path: root/include/clang/AST/CommentBriefParser.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/clang/AST/CommentBriefParser.h')
-rw-r--r--include/clang/AST/CommentBriefParser.h55
1 files changed, 0 insertions, 55 deletions
diff --git a/include/clang/AST/CommentBriefParser.h b/include/clang/AST/CommentBriefParser.h
deleted file mode 100644
index be5b8ee..0000000
--- a/include/clang/AST/CommentBriefParser.h
+++ /dev/null
@@ -1,55 +0,0 @@
-//===--- 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_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 \\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 the best "brief description" we can find.
- std::string Parse();
-};
-
-} // end namespace comments
-} // end namespace clang
-
-#endif
-
OpenPOWER on IntegriCloud