Added and cleaned up some comments.

This commit is contained in:
Morné Chamberlain 2012-10-13 12:54:51 +02:00
parent ef8aa081a1
commit cd76ec3e22
2 changed files with 13 additions and 3 deletions

View File

@ -86,7 +86,6 @@ void cmExtraSublimeTextGenerator::Generate()
} }
/* create the project file */
void cmExtraSublimeTextGenerator::CreateProjectFile( void cmExtraSublimeTextGenerator::CreateProjectFile(
const std::vector<cmLocalGenerator*>& lgs) const std::vector<cmLocalGenerator*>& lgs)
{ {
@ -206,8 +205,6 @@ void cmExtraSublimeTextGenerator
fout << "}"; fout << "}";
} }
// Get a list of all files and a set of all directories and subdirectories
// with source files
void cmExtraSublimeTextGenerator void cmExtraSublimeTextGenerator
::GetFileList(const std::vector<cmLocalGenerator*>& lgs, ::GetFileList(const std::vector<cmLocalGenerator*>& lgs,
std::vector<std::string>& allFiles) std::vector<std::string>& allFiles)

View File

@ -45,8 +45,15 @@ private:
void CreateNewProjectFile(const std::vector<cmLocalGenerator*>& lgs, void CreateNewProjectFile(const std::vector<cmLocalGenerator*>& lgs,
const std::string& filename); const std::string& filename);
/** Populates allFiles with the full paths to all of the source files
* from the local generators in lgs.
*/
void GetFileList(const std::vector<cmLocalGenerator*>& lgs, void GetFileList(const std::vector<cmLocalGenerator*>& lgs,
std::vector<std::string>& allFiles); std::vector<std::string>& allFiles);
/** Sends comma seperated source files paths to fileIncludePatternsStream
* and builds a set of all directories and subdirectories containing
* source files.
*/
void GetFileStringAndFolderSet(const std::vector<cmLocalGenerator*>& lgs, void GetFileStringAndFolderSet(const std::vector<cmLocalGenerator*>& lgs,
const cmMakefile* mf, const cmMakefile* mf,
const std::vector<std::string>& allFiles, const std::vector<std::string>& allFiles,
@ -61,8 +68,14 @@ private:
cmGeneratedFileStream& fout, cmGeneratedFileStream& fout,
std::set<std::string>& includeDirs, std::set<std::string>& includeDirs,
std::set<std::string>& defines); std::set<std::string>& defines);
/** Returns the build command that needs to be executed to build the
* specified target.
*/
std::string BuildMakeCommand(const std::string& make, const char* makefile, std::string BuildMakeCommand(const std::string& make, const char* makefile,
const char* target); const char* target);
/** Appends the specified target to the generated project file as a Sublime
* Text build system.
*/
void AppendTarget(cmGeneratedFileStream& fout, void AppendTarget(cmGeneratedFileStream& fout,
const char* targetName, const char* targetName,
cmTarget* target, cmTarget* target,