https://github.com/Kitware/CMake
Tip revision: 2a0c105cf08190284b288057c693eeddef5066fc authored by Brad King on 02 February 2023, 18:20:23 UTC
CMake 3.26.0-rc1
CMake 3.26.0-rc1
Tip revision: 2a0c105
cmDocumentationFormatter.h
/* 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>
#include <string>
class cmDocumentationSection;
/** Print documentation in a simple text format. */
class cmDocumentationFormatter
{
public:
void SetIndent(std::size_t indent) { this->TextIndent = indent; }
void PrintFormatted(std::ostream& os, std::string const& text) const;
void PrintSection(std::ostream& os, cmDocumentationSection const& section);
private:
void PrintPreformatted(std::ostream& os, std::string const&) const;
void PrintParagraph(std::ostream& os, std::string const&) const;
void PrintColumn(std::ostream& os, std::string const&) const;
std::size_t TextWidth = 77u;
std::size_t TextIndent = 0u;
};