f85405f551
Temporarily add a RST formatter to convert builtin documentation to .rst source files. This will be removed shortly after we use it to convert documentation. Teach the RST formatter to: * Output preformatted blocks as reStructuredText "::" literal blocks. * Output option lists as bullet lists with option names enclosed in reStructuredText ``literal`` quoting. * Output individual documentation objects (commands, variables, etc.) in separate .rst files organized in directories by type. Replace references to cmVersion::GetCMakeVersion() in builtin documentation with the literal placeholder "|release|" that will be defined as a substitution later.
35 lines
1.2 KiB
C++
35 lines
1.2 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 _cmDocumentationFormatterRST_h
|
|
#define _cmDocumentationFormatterRST_h
|
|
|
|
#include "cmStandardIncludes.h"
|
|
|
|
#include "cmDocumentationFormatterText.h"
|
|
|
|
/** Class to print the documentation as reStructuredText. */
|
|
class cmDocumentationFormatterRST : public cmDocumentationFormatterText
|
|
{
|
|
public:
|
|
cmDocumentationFormatterRST();
|
|
|
|
virtual cmDocumentationEnums::Form GetForm() const
|
|
{ return cmDocumentationEnums::RSTForm;}
|
|
|
|
virtual void PrintSection(std::ostream& os,
|
|
const cmDocumentationSection& section,
|
|
const char* name);
|
|
virtual void PrintPreformatted(std::ostream& os, const char* text);
|
|
};
|
|
|
|
#endif
|