CMake/Source/cmPropertyDefinition.cxx
Brad King 0c39a757da Drop the 'Full' field from cmDocumentationEntry
We need only 'Brief' for usage documentation.  We no longer have builtin
'Full' documentation, which is now in Help/*/*.rst files.
2013-10-16 09:22:37 -04:00

47 lines
1.3 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.
============================================================================*/
#include "cmPropertyDefinition.h"
#include "cmSystemTools.h"
cmDocumentationEntry cmPropertyDefinition::GetDocumentation() const
{
cmDocumentationEntry e;
e.Name = this->Name;
e.Brief = this->ShortDescription;
return e;
}
void cmPropertyDefinition
::DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *shortDescription,
const char *fullDescription,
const char *sec,
bool chain)
{
this->Name = name;
this->Scope = scope;
this->Chained = chain;
if (shortDescription)
{
this->ShortDescription = shortDescription;
}
if (fullDescription)
{
this->FullDescription = fullDescription;
}
if (sec)
{
this->DocumentationSection = sec;
}
}