class BriefParser

Declaration

class BriefParser { /* full declaration omitted */ };

Description

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:

Declared at: clang/include/clang/AST/CommentBriefParser.h:29

Member Variables

private clang::comments::Lexer& L

private const clang::comments::CommandTraits& Traits

private clang::comments::Token Tok

Current lookahead token.

Method Overview

• public BriefParser(clang::comments::Lexer & L, const clang::comments::CommandTraits & Traits)
• private clang::SourceLocation ConsumeToken()
• public std::string Parse()

Methods

¶BriefParser(
    clang::comments::Lexer& L,
    const clang::comments::CommandTraits& Traits)

Declared at: clang/include/clang/AST/CommentBriefParser.h:44

Parameters

clang::comments::Lexer& L

const clang::comments::CommandTraits& Traits

¶clang::SourceLocation ConsumeToken()

Declared at: clang/include/clang/AST/CommentBriefParser.h:37

¶std::string Parse()

Description

Return the best "brief description" we can find.

Declared at: clang/include/clang/AST/CommentBriefParser.h:47