clang::doc::TableCommentWriter Class Reference

Writer for writing comments to a table cell in MD. More...

Public Member Functions
	TableCommentWriter (llvm::raw_ostream &OS)
void	write (llvm::ArrayRef< CommentInfo > Comments)

Detailed Description

Writer for writing comments to a table cell in MD.

The writer traverses the comments recursively and outputs the comments into a stream. The formatter inserts single/double line breaks to retain the comment structure.

Usage : Initialize an object with a llvm::raw_ostream to output into. Call the write(C) function with an array of Comments 'C'.

Definition at line 81 of file MDGenerator.cpp.

Constructor & Destructor Documentation

TableCommentWriter()

clang::doc::TableCommentWriter::TableCommentWriter ( llvm::raw_ostream & OS )

inlineexplicit

Definition at line 83 of file MDGenerator.cpp.

Member Function Documentation

write()

void clang::doc::TableCommentWriter::write ( llvm::ArrayRef< CommentInfo > Comments )

inline

Definition at line 85 of file MDGenerator.cpp.

Referenced by clang::doc::genMarkdown().

---

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

• MDGenerator.cpp