43 lines
1.6 KiB
C++
43 lines
1.6 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 _cmDocumentationFormatterHTML_h
|
|
#define _cmDocumentationFormatterHTML_h
|
|
|
|
#include "cmStandardIncludes.h"
|
|
|
|
#include "cmDocumentationFormatter.h"
|
|
|
|
/** Class to print the documentation as HTML. */
|
|
class cmDocumentationFormatterHTML : public cmDocumentationFormatter
|
|
{
|
|
public:
|
|
cmDocumentationFormatterHTML();
|
|
|
|
virtual cmDocumentationEnums::Form GetForm() const
|
|
{ return cmDocumentationEnums::HTMLForm;}
|
|
|
|
virtual void PrintHeader(const char* docname, const char* appname,
|
|
std::ostream& os);
|
|
virtual void PrintFooter(std::ostream& os);
|
|
virtual void PrintSection(std::ostream& os,
|
|
const cmDocumentationSection& section,
|
|
const char* name);
|
|
virtual void PrintPreformatted(std::ostream& os, const char* text);
|
|
virtual void PrintParagraph(std::ostream& os, const char* text);
|
|
virtual void PrintIndex(std::ostream& ,
|
|
std::vector<const cmDocumentationSection *>&);
|
|
private:
|
|
void PrintHTMLEscapes(std::ostream& os, const char* text);
|
|
};
|
|
|
|
#endif
|