mirror of
https://github.com/reactos/CMake.git
synced 2024-11-30 23:10:26 +00:00
7bbaa4283d
Our Git commit hooks disallow modification or addition of lines with trailing whitespace. Wipe out all remnants of trailing whitespace everywhere except third-party code. Run the following shell code: git ls-files -z -- \ bootstrap doxygen.config '*.readme' \ '*.c' '*.cmake' '*.cpp' '*.cxx' \ '*.el' '*.f' '*.f90' '*.h' '*.in' '*.in.l' '*.java' \ '*.mm' '*.pike' '*.py' '*.txt' '*.vim' | egrep -z -v '^(Utilities/cm|Source/(kwsys|CursesDialog/form)/)' | egrep -z -v '^(Modules/CPack\..*\.in)' | xargs -0 sed -i 's/ \+$//'
69 lines
2.5 KiB
C++
69 lines
2.5 KiB
C++
/*============================================================================
|
|
CMake - Cross Platform Makefile Generator
|
|
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
|
|
|
|
Distributed under the OSI-approved BSD License (the "License");
|
|
see accompanying file Copyright.txt for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
See the License for more information.
|
|
============================================================================*/
|
|
#ifndef _cmDocumentationSection_h
|
|
#define _cmDocumentationSection_h
|
|
|
|
#include "cmStandardIncludes.h"
|
|
#include "cmDocumentationFormatter.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. */
|
|
cmDocumentationSection(const char* name, const char* manName)
|
|
:Name(name), ManName(manName) {}
|
|
|
|
/** 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 for the given output form. */
|
|
const char* GetName(cmDocumentationEnums::Form form) const
|
|
{ return (form==cmDocumentationEnums::ManForm ?
|
|
this->ManName.c_str() : this->Name.c_str()); }
|
|
|
|
/** 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 *[][3]);
|
|
void Append(const char *n, const char *b, const char *f);
|
|
|
|
/** prepend some documentation to this section */
|
|
void Prepend(const char *[][3]);
|
|
void Prepend(const std::vector<cmDocumentationEntry> &entries)
|
|
{ this->Entries.insert(this->Entries.begin(),
|
|
entries.begin(),entries.end()); }
|
|
|
|
|
|
private:
|
|
std::string Name;
|
|
std::string ManName;
|
|
std::vector<cmDocumentationEntry> Entries;
|
|
};
|
|
|
|
#endif
|