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.
67 lines
1.7 KiB
C++
67 lines
1.7 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef _cmDocumentationFormatter_h
|
|
#define _cmDocumentationFormatter_h
|
|
|
|
#include <cmConfigure.h> // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
|
|
/** This is just a helper class to make it build with MSVC 6.0.
|
|
Actually the enums and internal classes could directly go into
|
|
cmDocumentation, but then MSVC6 complains in RequestedHelpItem that
|
|
cmDocumentation is an undefined type and so it doesn't know the enums.
|
|
Moving the enums to a class which is then already completely parsed helps
|
|
against this. */
|
|
class cmDocumentationEnums
|
|
{
|
|
public:
|
|
/** Types of help provided. */
|
|
enum Type
|
|
{
|
|
None,
|
|
Version,
|
|
Usage,
|
|
Help,
|
|
Full,
|
|
ListManuals,
|
|
ListCommands,
|
|
ListModules,
|
|
ListProperties,
|
|
ListVariables,
|
|
ListPolicies,
|
|
ListGenerators,
|
|
OneManual,
|
|
OneCommand,
|
|
OneModule,
|
|
OneProperty,
|
|
OneVariable,
|
|
OnePolicy,
|
|
OldCustomModules
|
|
};
|
|
};
|
|
|
|
class cmDocumentationSection;
|
|
|
|
/** Print documentation in a simple text format. */
|
|
class cmDocumentationFormatter
|
|
{
|
|
public:
|
|
cmDocumentationFormatter();
|
|
virtual ~cmDocumentationFormatter();
|
|
void PrintFormatted(std::ostream& os, const char* text);
|
|
|
|
virtual void PrintSection(std::ostream& os,
|
|
cmDocumentationSection const& section);
|
|
virtual void PrintPreformatted(std::ostream& os, const char* text);
|
|
virtual void PrintParagraph(std::ostream& os, const char* text);
|
|
void PrintColumn(std::ostream& os, const char* text);
|
|
void SetIndent(const char* indent);
|
|
|
|
private:
|
|
int TextWidth;
|
|
const char* TextIndent;
|
|
};
|
|
|
|
#endif
|