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.
88 lines
2.5 KiB
88 lines
2.5 KiB
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
Module: $RCSfile: cmDocumentationFormatterMan.cxx,v $
|
|
Language: C++
|
|
Date: $Date: 2007-10-22 16:48:39 $
|
|
Version: $Revision: 1.5 $
|
|
|
|
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
|
|
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notices for more information.
|
|
|
|
=========================================================================*/
|
|
|
|
#include "cmDocumentationFormatterMan.h"
|
|
#include "cmDocumentationSection.h"
|
|
|
|
#include "cmSystemTools.h"
|
|
#include "cmVersion.h"
|
|
|
|
|
|
cmDocumentationFormatterMan::cmDocumentationFormatterMan()
|
|
:cmDocumentationFormatter()
|
|
{
|
|
}
|
|
|
|
void cmDocumentationFormatterMan
|
|
::PrintSection(std::ostream& os,
|
|
const cmDocumentationSection §ion,
|
|
const char* name)
|
|
{
|
|
if(name)
|
|
{
|
|
os << ".SH " << name << "\n";
|
|
}
|
|
|
|
const std::vector<cmDocumentationEntry> &entries =
|
|
section.GetEntries();
|
|
for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
|
|
op != entries.end(); ++op)
|
|
{
|
|
if(op->Name.size())
|
|
{
|
|
os << ".TP\n"
|
|
<< ".B " << (op->Name.size()?op->Name.c_str():"*") << "\n";
|
|
this->PrintFormatted(os, op->Brief.c_str());
|
|
this->PrintFormatted(os, op->Full.c_str());
|
|
}
|
|
else
|
|
{
|
|
os << ".PP\n";
|
|
this->PrintFormatted(os, op->Brief.c_str());
|
|
}
|
|
}
|
|
}
|
|
|
|
void cmDocumentationFormatterMan::PrintPreformatted(std::ostream& os,
|
|
const char* text)
|
|
{
|
|
std::string man_text = text;
|
|
cmSystemTools::ReplaceString(man_text, "\\", "\\\\");
|
|
os << man_text << "\n";
|
|
}
|
|
|
|
void cmDocumentationFormatterMan::PrintParagraph(std::ostream& os,
|
|
const char* text)
|
|
{
|
|
std::string man_text = text;
|
|
cmSystemTools::ReplaceString(man_text, "\\", "\\\\");
|
|
os << man_text << "\n\n";
|
|
}
|
|
|
|
|
|
//----------------------------------------------------------------------------
|
|
void cmDocumentationFormatterMan::PrintHeader(const char* name,
|
|
std::ostream& os)
|
|
{
|
|
os << ".TH " << name << " 1 \""
|
|
<< cmSystemTools::GetCurrentDateTime("%B %d, %Y").c_str()
|
|
<< "\" \"" << name
|
|
<< " " << cmVersion::GetCMakeVersion()
|
|
<< "\"\n";
|
|
}
|
|
|