CMake/Source/cmIncludeExternalMSProjectCommand.h
2001-10-31 07:03:32 -05:00

59 lines
1.5 KiB
C++

#ifndef cmIncludeExternalMSProjectCommand_h
#define cmIncludeExternalMSProjectCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmIncludeExternalMSProjectCommand
* \brief Specify an external MS project file for inclusion in the workspace.
*
* cmIncludeExternalMSProjectCommand is used to specify an externally generated
* Microsoft project file for inclusion in the default workspace generated by
* CMake.
*/
class cmIncludeExternalMSProjectCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmIncludeExternalMSProjectCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "INCLUDE_EXTERNAL_MSPROJECT";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Include an external Microsoft project file in a workspace.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"INCLUDE_EXTERNAL_MSPROJECT(projectname location dep1 dep2 ...) Includes an external Microsoft project in the workspace file. Does nothing on UNIX currently\n";
}
cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);
};
#endif