CMake/Source/cmSiteNameCommand.h
David Cole edcdfeae93 Documentation: Fix comments in the source code (#10941)
Previously, the comments had all been copied and pasted
and not fixed up... Now they are fixed up.
2011-08-04 19:03:24 -04:00

73 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 cmSiteNameCommand_h
#define cmSiteNameCommand_h
#include "cmCommand.h"
/** \class cmSiteNameCommand
* \brief site_name command
*
* cmSiteNameCommand implements the site_name CMake command
*/
class cmSiteNameCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmSiteNameCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "site_name";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Set the given variable to the name of the computer.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" site_name(variable)\n";
}
cmTypeMacro(cmSiteNameCommand, cmCommand);
};
#endif