mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-22 22:31:18 -05:00
Code Issues Packages Projects Releases Wiki Activity

ENH: add some more comments

Browse Source
This commit is contained in:
Bill Hoffman
2004-10-25 16:39:13 -04:00
parent 5eda379907
commit ccea94278b
2 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Source/cmLocalKdevelopGenerator.h
+14 -4
View File
@@ -26,10 +26,15 @@ class cmTarget;
class cmSourceFile;
/** \class cmLocalKdevelopGenerator
* \brief Write a LocalUnix makefiles.
* \brief Write Unix Makefiles accompanied by KDevelop3 project files.
*
* cmLocalKdevelopGenerator produces a LocalUnix makefile from its
* member m_Makefile.
* cmLocalKdevelopGenerator produces a project file for KDevelop 3 (KDevelop > 3.1.1).
* The project is based on the "Custom Makefile based C/C++" project of KDevelop.
* Such a project consists of Unix Makefiles in the build directory together
* with a <your_project>.kdevelop project file, which contains the project settings
* and a <your_project>.kdevelop.filelist file, which lists the source files relative
* to the kdevelop project directory. The kdevelop project directory is the base
* source directory.
*/
class cmLocalKdevelopGenerator : public cmLocalUnixMakefileGenerator
{
@@ -51,11 +56,16 @@ protected:
/**
Create the foo.kdevelop file. This one calls MergeProjectFiles()
if it already exists, otherwise createNewProjectFile()
The project files will be created in \a outputDir (in the build tree), the kdevelop project
dir will be set to \a projectDir (in the source tree). \a cmakeFilePattern consists of a lists
of all cmake listfiles used by this CMakeLists.txt
*/
void CreateProjectFile(const std::string& outputDir, const std::string& projectDir,
const std::string& projectname, const std::string& executable,
const std::string& cmakeFilePattern);
///! Create the foo.kdevelop.filelist file, return false if it doesn't succeed
/** Create the foo.kdevelop.filelist file, return false if it doesn't succeed.
If the file already exists the contents will be merged.
*/
bool CreateFilelistFile(const std::string& outputDir, const std::string& projectDir,
const std::string& projectname, std::string& cmakeFilePattern);
///! Reads the old foo.kdevelop line by line and only replaces the "important" lines