TextGeneratorOLImpl Class Reference

Implements TextGeneratorIntf for an OutputDocInterface stream. More...

#include <src/outputlist.h>

Inheritance diagram for TextGeneratorOLImpl:

Collaboration diagram for TextGeneratorOLImpl:

Public Member Functions
	TextGeneratorOLImpl (OutputList &ol)
void	writeString (std::string_view s, bool keepSpaces) const override
void	writeBreak (int indent) const override
void	writeLink (const DString &extRef, const DString &file, const DString &anchor, std::string_view text) const override

Private Attributes
OutputList &	m_ol

Detailed Description

Implements TextGeneratorIntf for an OutputDocInterface stream.

Definition at line 785 of file outputlist.h.

Constructor & Destructor Documentation

TextGeneratorOLImpl()

TextGeneratorOLImpl::TextGeneratorOLImpl

(

OutputList &

ol

)

Definition at line 219 of file outputlist.cpp.

                                                       : m_ol(ol)
{
}

References m_ol.

Referenced by MemberDefImpl::_writeTemplatePrefix(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), writeExceptionListImpl(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeTemplateSpec(), and writeTypeConstraints().

Member Function Documentation

writeBreak()

void TextGeneratorOLImpl::writeBreak ( int indent ) const

overridevirtual

Implements TextGeneratorIntf.

Definition at line 247 of file outputlist.cpp.

{
  m_ol.lineBreak("typebreak");
  for (int i = 0; i < indent; ++i) m_ol.writeNonBreakableSpace(3);
}

References OutputList::lineBreak(), m_ol, and OutputList::writeNonBreakableSpace().

writeLink()

void TextGeneratorOLImpl::writeLink ( const DString & extRef, const DString & file, const DString & anchor, std::string_view text ) const

overridevirtual

Implements TextGeneratorIntf.

Definition at line 253 of file outputlist.cpp.

{
  //printf("TextGeneratorOlImpl::writeLink('%s')\n",text);
  m_ol.writeObjectLink(extRef,file,anchor,text);
}

References m_ol, and OutputList::writeObjectLink().

writeString()

void TextGeneratorOLImpl::writeString ( std::string_view s, bool keepSpaces ) const

overridevirtual

Implements TextGeneratorIntf.

Definition at line 223 of file outputlist.cpp.

{
  if (s.empty()) return;
  //printf("TextGeneratorOlImpl::writeString('%s',%d)\n",s,keepSpaces);
  if (keepSpaces)
  {
    for (char c : s)
    {
      if (c == ' ')
      {
        m_ol.writeNonBreakableSpace(1);
      }
      else
      {
        m_ol.docify(std::string_view(&c, 1));
      }
    }
  }
  else
  {
    m_ol.docify(s);
  }
}

References OutputList::docify(), m_ol, and OutputList::writeNonBreakableSpace().

Member Data Documentation

m_ol

OutputList& TextGeneratorOLImpl::m_ol

private

Definition at line 795 of file outputlist.h.

Referenced by TextGeneratorOLImpl(), writeBreak(), writeLink(), and writeString().

---

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

• src/outputlist.h
• src/outputlist.cpp