clang-tools 19.0.0git
Public Member Functions | List of all members
clang::clangd::markup::Block Class Referenceabstract

Holds text and knows how to lay it out. More...

#include <Markup.h>

Inheritance diagram for clang::clangd::markup::Block:
Inheritance graph

Public Member Functions

virtual void renderMarkdown (llvm::raw_ostream &OS) const =0
virtual void renderPlainText (llvm::raw_ostream &OS) const =0
virtual std::unique_ptr< Blockclone () const =0
std::string asMarkdown () const
std::string asPlainText () const
virtual bool isRuler () const
virtual ~Block ()=default

Detailed Description

Holds text and knows how to lay it out.

Multiple blocks can be grouped to form a document. Blocks include their own trailing newlines, container should trim them if need be.

Definition at line 28 of file Markup.h.

Constructor & Destructor Documentation

◆ ~Block()

virtual clang::clangd::markup::Block::~Block ( )

Member Function Documentation

◆ asMarkdown()

std::string clang::clangd::markup::Block::asMarkdown ( ) const

Definition at line 330 of file Markup.cpp.

References OS, and renderMarkdown().

◆ asPlainText()

std::string clang::clangd::markup::Block::asPlainText ( ) const

Definition at line 337 of file Markup.cpp.

References OS, and renderPlainText().

◆ clone()

virtual std::unique_ptr< Block > clang::clangd::markup::Block::clone ( ) const
pure virtual

◆ isRuler()

virtual bool clang::clangd::markup::Block::isRuler ( ) const

Definition at line 36 of file Markup.h.

◆ renderMarkdown()

virtual void clang::clangd::markup::Block::renderMarkdown ( llvm::raw_ostream &  OS) const
pure virtual

◆ renderPlainText()

virtual void clang::clangd::markup::Block::renderPlainText ( llvm::raw_ostream &  OS) const
pure virtual

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