summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationFormatter.h
blob: ca7ad0c5df2028237bbf51fe165915332983faec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing for details.  */
#pragma once

#include "cmConfigure.h" // IWYU pragma: keep

#include <iosfwd>

class cmDocumentationSection;

/** Print documentation in a simple text format. */
class cmDocumentationFormatter
{
public:
  void PrintFormatted(std::ostream& os, const char* text);
  void PrintSection(std::ostream& os, cmDocumentationSection const& section);
  void PrintPreformatted(std::ostream& os, const char* text);
  void PrintParagraph(std::ostream& os, const char* text);
  void PrintColumn(std::ostream& os, const char* text);
  void SetIndent(const char* indent);

private:
  int TextWidth = 77;
  const char* TextIndent = "";
};