mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-06 21:59:54 -06:00
ab1b9b45ff
This corrects the terse documentation and adds detail to the full documentation of some commands. It also normalizes the layout of the documentation string endings to make adding lines easier.
79 lines
2.0 KiB
C++
79 lines
2.0 KiB
C++
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
Module: $RCSfile$
|
|
Language: C++
|
|
Date: $Date$
|
|
Version: $Revision$
|
|
|
|
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
|
|
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notices for more information.
|
|
|
|
=========================================================================*/
|
|
#ifndef cmCTestCoverageCommand_h
|
|
#define cmCTestCoverageCommand_h
|
|
|
|
#include "cmCTestHandlerCommand.h"
|
|
|
|
/** \class cmCTestCoverage
|
|
* \brief Run a ctest script
|
|
*
|
|
* cmCTestCoverageCommand defineds the command to test the project.
|
|
*/
|
|
class cmCTestCoverageCommand : public cmCTestHandlerCommand
|
|
{
|
|
public:
|
|
|
|
cmCTestCoverageCommand() {}
|
|
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
cmCTestCoverageCommand* ni = new cmCTestCoverageCommand;
|
|
ni->CTest = this->CTest;
|
|
ni->CTestScriptHandler = this->CTestScriptHandler;
|
|
return ni;
|
|
}
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() { return "ctest_coverage";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "Collect coverage tool results.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" ctest_coverage([BUILD build_dir] [RETURN_VALUE res])\n"
|
|
"Perform the coverage of the given build directory and stores results "
|
|
"in Coverage.xml. The second argument is a variable that will hold "
|
|
"value."
|
|
;
|
|
}
|
|
|
|
cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand);
|
|
|
|
protected:
|
|
cmCTestGenericHandler* InitializeHandler();
|
|
};
|
|
|
|
|
|
#endif
|
|
|