CMake/Source/cmGetTestPropertyCommand.h
Brad King 4c980e36bb Reference get_property() from old get_*_property() commands
The former is a much more general and modern command.  Refer authors to
it from documentation of its predecessors.
2011-01-17 09:19:45 -05:00

66 lines
1.8 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 cmGetTestPropertyCommand_h
#define cmGetTestPropertyCommand_h
#include "cmCommand.h"
class cmGetTestPropertyCommand : public cmCommand
{
public:
virtual cmCommand* Clone()
{
return new cmGetTestPropertyCommand;
}
/**
* This is called when the command is first encountered in
* the input file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "get_test_property";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Get a property of the test.";
}
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" get_test_property(test property VAR)\n"
"Get a property from the Test. The value of the property is "
"stored in the variable VAR. If the property is not found, VAR "
"will be set to \"NOTFOUND\". For a list of standard properties "
"you can type cmake --help-property-list"
"\n"
"See also the more general get_property() command.";
}
cmTypeMacro(cmGetTestPropertyCommand, cmCommand);
};
#endif