Drop unused builtin documentation APIs

Now that all DefineProperty documentation calls have been dropped, drop
the supporting APIs.
This commit is contained in:
Brad King 2013-09-17 09:08:58 -04:00
parent 0c39a757da
commit 53ded59515
6 changed files with 3 additions and 29 deletions

View File

@ -12,19 +12,10 @@
#include "cmPropertyDefinition.h" #include "cmPropertyDefinition.h"
#include "cmSystemTools.h" #include "cmSystemTools.h"
cmDocumentationEntry cmPropertyDefinition::GetDocumentation() const
{
cmDocumentationEntry e;
e.Name = this->Name;
e.Brief = this->ShortDescription;
return e;
}
void cmPropertyDefinition void cmPropertyDefinition
::DefineProperty(const char *name, cmProperty::ScopeType scope, ::DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *shortDescription, const char *shortDescription,
const char *fullDescription, const char *fullDescription,
const char *sec,
bool chain) bool chain)
{ {
this->Name = name; this->Name = name;
@ -38,9 +29,5 @@ void cmPropertyDefinition
{ {
this->FullDescription = fullDescription; this->FullDescription = fullDescription;
} }
if (sec)
{
this->DocumentationSection = sec;
}
} }

View File

@ -30,22 +30,14 @@ public:
void DefineProperty(const char *name, cmProperty::ScopeType scope, void DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *ShortDescription, const char *ShortDescription,
const char *FullDescription, const char *FullDescription,
const char *DocumentationSection,
bool chained); bool chained);
/// Get the documentation string
cmDocumentationEntry GetDocumentation() const;
/// Default constructor /// Default constructor
cmPropertyDefinition() { this->Chained = false; }; cmPropertyDefinition() { this->Chained = false; };
/// Is the property chained? /// Is the property chained?
bool IsChained() const { return this->Chained; }; bool IsChained() const { return this->Chained; };
/// Get the section if any
const std::string &GetDocumentationSection() const {
return this->DocumentationSection; };
/// Get the scope /// Get the scope
cmProperty::ScopeType GetScope() const { cmProperty::ScopeType GetScope() const {
return this->Scope; }; return this->Scope; };
@ -62,7 +54,6 @@ protected:
std::string Name; std::string Name;
std::string ShortDescription; std::string ShortDescription;
std::string FullDescription; std::string FullDescription;
std::string DocumentationSection;
cmProperty::ScopeType Scope; cmProperty::ScopeType Scope;
bool Chained; bool Chained;
}; };

View File

@ -17,7 +17,6 @@ void cmPropertyDefinitionMap
::DefineProperty(const char *name, cmProperty::ScopeType scope, ::DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *ShortDescription, const char *ShortDescription,
const char *FullDescription, const char *FullDescription,
const char *DocumentationSection,
bool chain) bool chain)
{ {
if (!name) if (!name)
@ -31,7 +30,7 @@ void cmPropertyDefinitionMap
{ {
prop = &(*this)[name]; prop = &(*this)[name];
prop->DefineProperty(name,scope,ShortDescription, FullDescription, prop->DefineProperty(name,scope,ShortDescription, FullDescription,
DocumentationSection, chain); chain);
} }
} }

View File

@ -24,7 +24,6 @@ public:
void DefineProperty(const char *name, cmProperty::ScopeType scope, void DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *ShortDescription, const char *ShortDescription,
const char *FullDescription, const char *FullDescription,
const char *DocumentaitonSection,
bool chain); bool chain);
// has a named property been defined // has a named property been defined

View File

@ -2376,11 +2376,10 @@ void cmake::GenerateGraphViz(const char* fileName) const
void cmake::DefineProperty(const char *name, cmProperty::ScopeType scope, void cmake::DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *ShortDescription, const char *ShortDescription,
const char *FullDescription, const char *FullDescription,
bool chained, const char *docSection) bool chained)
{ {
this->PropertyDefinitions[scope].DefineProperty(name,scope,ShortDescription, this->PropertyDefinitions[scope].DefineProperty(name,scope,ShortDescription,
FullDescription, FullDescription,
docSection,
chained); chained);
} }

View File

@ -330,8 +330,7 @@ class cmake
void DefineProperty(const char *name, cmProperty::ScopeType scope, void DefineProperty(const char *name, cmProperty::ScopeType scope,
const char *ShortDescription, const char *ShortDescription,
const char *FullDescription, const char *FullDescription,
bool chain = false, bool chain = false);
const char *variableGroup = 0);
// get property definition // get property definition
cmPropertyDefinition *GetPropertyDefinition cmPropertyDefinition *GetPropertyDefinition