You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
2.3 KiB
67 lines
2.3 KiB
/*============================================================================
|
|
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*)
|
|
: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. */
|
|
const char* GetName() const
|
|
{ return 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 *[][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
|