mirror of
https://github.com/reactos/CMake.git
synced 2024-11-25 12:40:06 +00:00
86578eccf2
Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
70 lines
1.9 KiB
C++
70 lines
1.9 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef _cmDocumentationSection_h
|
|
#define _cmDocumentationSection_h
|
|
|
|
#include <cmConfigure.h> // IWYU pragma: keep
|
|
|
|
#include "cmDocumentationEntry.h"
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
// 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. */
|
|
cmDocumentationSection(const char* name, const char*)
|
|
: 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);
|
|
}
|
|
void Append(const std::vector<cmDocumentationEntry>& entries)
|
|
{
|
|
this->Entries.insert(this->Entries.end(), entries.begin(), entries.end());
|
|
}
|
|
|
|
/** Append an entry to this section using NULL terminated chars */
|
|
void Append(const char* [][2]);
|
|
void Append(const char* n, const char* b);
|
|
|
|
/** prepend some documentation to this section */
|
|
void Prepend(const char* [][2]);
|
|
void Prepend(const std::vector<cmDocumentationEntry>& entries)
|
|
{
|
|
this->Entries.insert(this->Entries.begin(), entries.begin(),
|
|
entries.end());
|
|
}
|
|
|
|
private:
|
|
std::string Name;
|
|
std::vector<cmDocumentationEntry> Entries;
|
|
};
|
|
|
|
#endif
|