AbstractFormatter

namespace	bhenk\doc2rst\format
predicates	Abstract
implements	Stringable
known subclasses	CodeBlockFormatter | RestructuredTextFormatter

Formatters transform specific PHPDoc-blocks to reStructuredText

---

Methods

AbstractFormatter::handleLine

predicates

public | abstract

Handle a line of PHPDoc

As long as the formatter wants more lines it should return true. When it has enough it should return false.

public abstract function handleLine(
      Parameter #0 [ <required> string $line ]
 ): bool

param string $line - line to format

return bool - true if more lines are welcome, false otherwise

---

AbstractFormatter::addLine

predicates

protected

Add a line to the resulting block

protected function addLine(
      Parameter #0 [ <required> Stringable|string $line ]
 ): void

param Stringable | string $line - the line to add

return void

---

AbstractFormatter::__toString

predicates	public
implements	Stringable::__toString

Returns a reStructuredText representation of the contents of the block

public function __toString(): string

return string - reStructuredText representation of the contents

---

AbstractFormatter::getLineCount

predicates

protected

protected function getLineCount(): int

return int

---

AbstractFormatter::increaseLineCount

predicates

protected

protected function increaseLineCount(): int

return int

---

Fri, 31 Mar 2023 13:22:46 +0000