clang  6.0.0svn
Public Member Functions | List of all members
clang::comments::BriefParser Class Reference

A very simple comment parser that extracts "a brief description". More...

#include "clang/AST/CommentBriefParser.h"

Public Member Functions

 BriefParser (Lexer &L, const CommandTraits &Traits)
 
std::string Parse ()
 Return the best "brief description" we can find. More...
 

Detailed 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:

Definition at line 30 of file CommentBriefParser.h.

Constructor & Destructor Documentation

◆ BriefParser()

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

Definition at line 57 of file CommentBriefParser.cpp.

Member Function Documentation

◆ Parse()

std::string clang::comments::BriefParser::Parse ( )

The documentation for this class was generated from the following files: