1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-06-09 15:38:15 +08:00
CMake/Source/cmDocumentationSection.h
Alex Turbov 69918b07e1 cmDocumentationEntry: Drop all user provided ctors for C++ >= 14
There is no need for them cuz:

- the last field has a default value
- all static instances use 2 arguments convertible to `std::string`
- "dynamic" instances used for _Generator_ doc entries access
  fields diectly using default constructed instance

Moreover, compiler may generate move ctor/assign when needed.
2022-11-17 16:37:12 +04:00

67 lines
1.8 KiB
C++

/* 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 <iterator>
#include <string>
#include <vector>
#include "cmDocumentationEntry.h"
// Low-level interface for custom documents:
/** Internal class representing a section of the documentation.
* Cares e.g. for the different section titles in the different
* output formats.
*/
class cmDocumentationSection
{
public:
/** Create a cmSection, with a special name for man-output mode. */
explicit cmDocumentationSection(const char* name)
: Name(name)
{
}
/** Has any content been added to this section or is it empty ? */
bool IsEmpty() const { return this->Entries.empty(); }
/** Clear contents. */
void Clear() { this->Entries.clear(); }
/** Return the name of this section. */
std::string GetName() const { return this->Name; }
/** Return a pointer to the first entry of this section. */
const std::vector<cmDocumentationEntry>& GetEntries() const
{
return this->Entries;
}
/** Append an entry to this section. */
void Append(const cmDocumentationEntry& entry)
{
this->Entries.push_back(entry);
}
template <typename Iterable>
void Append(const Iterable& entries)
{
this->Entries.insert(std::end(this->Entries), std::begin(entries),
std::end(entries));
}
/** prepend some documentation to this section */
template <typename Iterable>
void Prepend(const Iterable& entries)
{
this->Entries.insert(std::begin(this->Entries), std::begin(entries),
std::end(entries));
}
private:
std::string Name;
std::vector<cmDocumentationEntry> Entries;
};