Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-05-08 22:37:04 +08:00
Code Issues Projects Releases Wiki Activity

Fix invalid ///! doxygen comment line starts

Browse Source 
In various places `///!` was used to start a comment line.  This is not valid
Doygen syntax.  This patch replaces `///!` comment starts with `//!`.
This commit is contained in:
Sebastian Holtermann 2019-03-31 11:27:12 +02:00
parent 11475cc581
commit 735c6f39d9
43 changed files with 180 additions and 180 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Source/CTest/cmCTestBuildAndTestHandler.h
View File

@ -44,7 +44,7 @@ public:
void Initialize() override;
protected:
///! Run CMake and build a test and then run it as a single test.
//! Run CMake and build a test and then run it as a single test.
int RunCMakeAndTest(std::string* output);
int RunCMake(std::string* outstring, std::ostringstream& out,
std::string& cmakeOutString, cmake* cm);

6
Source/CTest/cmCTestMemCheckHandler.h
View File

@ -114,7 +114,7 @@ private:
// this type of checker
void InitializeResultsVectors();
///! Initialize memory checking subsystem.
//! Initialize memory checking subsystem.
bool InitializeMemoryChecking();
/**
@ -143,11 +143,11 @@ private:
void PostProcessTest(cmCTestTestResult& res, int test);
void PostProcessBoundsCheckerTest(cmCTestTestResult& res, int test);
///! append MemoryTesterOutputFile to the test log
//! append MemoryTesterOutputFile to the test log
void AppendMemTesterOutput(cmCTestTestHandler::cmCTestTestResult& res,
std::string const& filename);
///! generate the output filename for the given test index
//! generate the output filename for the given test index
void TestOutputFileNames(int test, std::vector<std::string>& files);
};

4
Source/CTest/cmCTestTestHandler.h
View File

@ -59,7 +59,7 @@ public:
*/
void PopulateCustomVectors(cmMakefile* mf) override;
///! Control the use of the regular expresisons, call these methods to turn
//! Control the use of the regular expresisons, call these methods to turn
/// them on
void UseIncludeRegExp();
void UseExcludeRegExp();
@ -78,7 +78,7 @@ public:
this->CustomMaximumFailedTestOutputSize = n;
}
///! pass the -I argument down
//! pass the -I argument down
void SetTestsToRunInformation(const char*);
cmCTestTestHandler();

24
Source/cmCacheManager.h
View File

@ -93,33 +93,33 @@ public:
CacheEntry& GetEntry() { return this->Position->second; }
};
///! return an iterator to iterate through the cache map
//! return an iterator to iterate through the cache map
cmCacheManager::CacheIterator NewIterator() { return CacheIterator(*this); }
///! Load a cache for given makefile. Loads from path/CMakeCache.txt.
//! Load a cache for given makefile. Loads from path/CMakeCache.txt.
bool LoadCache(const std::string& path, bool internal,
std::set<std::string>& excludes,
std::set<std::string>& includes);
///! Save cache for given makefile. Saves to output path/CMakeCache.txt
//! Save cache for given makefile. Saves to output path/CMakeCache.txt
bool SaveCache(const std::string& path, cmMessenger* messenger);
///! Delete the cache given
//! Delete the cache given
bool DeleteCache(const std::string& path);
///! Print the cache to a stream
//! Print the cache to a stream
void PrintCache(std::ostream&) const;
///! Get the iterator for an entry with a given key.
//! Get the iterator for an entry with a given key.
cmCacheManager::CacheIterator GetCacheIterator(const char* key = nullptr);
///! Remove an entry from the cache
//! Remove an entry from the cache
void RemoveCacheEntry(const std::string& key);
///! Get the number of entries in the cache
//! Get the number of entries in the cache
int GetSize() { return static_cast<int>(this->Cache.size()); }
///! Get a value from the cache given a key
//! Get a value from the cache given a key
const std::string* GetInitializedCacheValue(const std::string& key) const;
const char* GetCacheEntryValue(const std::string& key)
@ -197,14 +197,14 @@ public:
unsigned int GetCacheMinorVersion() const { return this->CacheMinorVersion; }
protected:
///! Add an entry into the cache
//! Add an entry into the cache
void AddCacheEntry(const std::string& key, const char* value,
const char* helpString,
cmStateEnums::CacheEntryType type);
///! Get a cache entry object for a key
//! Get a cache entry object for a key
CacheEntry* GetCacheEntry(const std::string& key);
///! Clean out the CMakeFiles directory if no CMakeCache.txt
//! Clean out the CMakeFiles directory if no CMakeCache.txt
void CleanCMakeFiles(const std::string& path);
// Cache version info

30
Source/cmCallVisualStudioMacro.cxx
View File

@ -35,8 +35,8 @@ static bool LogErrorsAsMessages;
# endif
# endif
///! Use ReportHRESULT to make a cmSystemTools::Message after calling
///! a COM method that may have failed.
//! Use ReportHRESULT to make a cmSystemTools::Message after calling
//! a COM method that may have failed.
# define ReportHRESULT(hr, context) \
if (FAILED(hr)) { \
if (LogErrorsAsMessages) { \
@ -50,7 +50,7 @@ static bool LogErrorsAsMessages;
} \
}
///! Using the given instance of Visual Studio, call the named macro
//! Using the given instance of Visual Studio, call the named macro
HRESULT InstanceCallMacro(IDispatch* vsIDE, const std::string& macro,
const std::string& args)
{
@ -133,7 +133,7 @@ HRESULT InstanceCallMacro(IDispatch* vsIDE, const std::string& macro,
return hr;
}
///! Get the Solution object from the IDE object
//! Get the Solution object from the IDE object
HRESULT GetSolutionObject(IDispatch* vsIDE, IDispatchPtr& vsSolution)
{
HRESULT hr = E_POINTER;
@ -176,7 +176,7 @@ HRESULT GetSolutionObject(IDispatch* vsIDE, IDispatchPtr& vsSolution)
return hr;
}
///! Get the FullName property from the Solution object
//! Get the FullName property from the Solution object
HRESULT GetSolutionFullName(IDispatch* vsSolution, std::string& fullName)
{
HRESULT hr = E_POINTER;
@ -220,7 +220,7 @@ HRESULT GetSolutionFullName(IDispatch* vsSolution, std::string& fullName)
return hr;
}
///! Get the FullName property from the Solution object, given the IDE object
//! Get the FullName property from the Solution object, given the IDE object
HRESULT GetIDESolutionFullName(IDispatch* vsIDE, std::string& fullName)
{
IDispatchPtr vsSolution;
@ -235,8 +235,8 @@ HRESULT GetIDESolutionFullName(IDispatch* vsIDE, std::string& fullName)
return hr;
}
///! Get all running objects from the Windows running object table.
///! Save them in a map by their display names.
//! Get all running objects from the Windows running object table.
//! Save them in a map by their display names.
HRESULT GetRunningInstances(std::map<std::string, IUnknownPtr>& mrot)
{
// mrot == Map of the Running Object Table
@ -292,8 +292,8 @@ HRESULT GetRunningInstances(std::map<std::string, IUnknownPtr>& mrot)
return hr;
}
///! Do the two file names refer to the same Visual Studio solution? Or are
///! we perhaps looking for any and all solutions?
//! Do the two file names refer to the same Visual Studio solution? Or are
//! we perhaps looking for any and all solutions?
bool FilesSameSolution(const std::string& slnFile, const std::string& slnName)
{
if (slnFile == "ALL" || slnName == "ALL") {
@ -310,9 +310,9 @@ bool FilesSameSolution(const std::string& slnFile, const std::string& slnName)
return s1 == s2;
}
///! Find instances of Visual Studio with the given solution file
///! open. Pass "ALL" for slnFile to gather all running instances
///! of Visual Studio.
//! Find instances of Visual Studio with the given solution file
//! open. Pass "ALL" for slnFile to gather all running instances
//! of Visual Studio.
HRESULT FindVisualStudioInstances(const std::string& slnFile,
std::vector<IDispatchPtr>& instances)
{
@ -384,8 +384,8 @@ int cmCallVisualStudioMacro::GetNumberOfRunningVisualStudioInstances(
return count;
}
///! Get all running objects from the Windows running object table.
///! Save them in a map by their display names.
//! Get all running objects from the Windows running object table.
//! Save them in a map by their display names.
int cmCallVisualStudioMacro::CallMacro(const std::string& slnFile,
const std::string& macro,
const std::string& args,

12
Source/cmCallVisualStudioMacro.h
View File

@ -16,16 +16,16 @@
class cmCallVisualStudioMacro
{
public:
///! Call the named macro in instances of Visual Studio with the
///! given solution file open. Pass "ALL" for slnFile to call the
///! macro in each Visual Studio instance.
//! Call the named macro in instances of Visual Studio with the
//! given solution file open. Pass "ALL" for slnFile to call the
//! macro in each Visual Studio instance.
static int CallMacro(const std::string& slnFile, const std::string& macro,
const std::string& args,
const bool logErrorsAsMessages);
///! Count the number of running instances of Visual Studio with the
///! given solution file open. Pass "ALL" for slnFile to count all
///! running Visual Studio instances.
//! Count the number of running instances of Visual Studio with the
//! given solution file open. Pass "ALL" for slnFile to count all
//! running Visual Studio instances.
static int GetNumberOfRunningVisualStudioInstances(
const std::string& slnFile);

10
Source/cmExternalMakefileProjectGenerator.h
View File

@ -31,13 +31,13 @@ public:
virtual void EnableLanguage(std::vector<std::string> const& languages,
cmMakefile*, bool optional);
///! set the global generator which will generate the makefiles
//! set the global generator which will generate the makefiles
virtual void SetGlobalGenerator(cmGlobalGenerator* generator)
{
this->GlobalGenerator = generator;
}
///! Return the list of global generators supported by this extra generator
//! Return the list of global generators supported by this extra generator
const std::vector<std::string>& GetSupportedGlobalGenerators() const
{
return this->SupportedGlobalGenerators;
@ -49,7 +49,7 @@ public:
static std::string CreateFullGeneratorName(
const std::string& globalGenerator, const std::string& extraGenerator);
///! Generate the project files, the Makefiles have already been generated
//! Generate the project files, the Makefiles have already been generated
virtual void Generate() = 0;
void SetName(const std::string& n) { Name = n; }
@ -59,9 +59,9 @@ public:
bool dryRun);
protected:
///! Contains the names of the global generators support by this generator.
//! Contains the names of the global generators support by this generator.
std::vector<std::string> SupportedGlobalGenerators;
///! the global generator which creates the makefiles
//! the global generator which creates the makefiles
const cmGlobalGenerator* GlobalGenerator = nullptr;
std::string Name;

6
Source/cmGeneratorTarget.h
View File

@ -69,9 +69,9 @@ public:
std::string GetExportName() const;
std::vector<std::string> GetPropertyKeys() const;
///! Might return a nullptr if the property is not set or invalid
//! Might return a nullptr if the property is not set or invalid
const char* GetProperty(const std::string& prop) const;
///! Always returns a valid pointer
//! Always returns a valid pointer
const char* GetSafeProperty(const std::string& prop) const;
bool GetPropertyAsBool(const std::string& prop) const;
void GetSourceFiles(std::vector<cmSourceFile*>& files,
@ -602,7 +602,7 @@ public:
pdb output directory is given. */
std::string GetPDBDirectory(const std::string& config) const;
///! Return the preferred linker language for this target
//! Return the preferred linker language for this target
std::string GetLinkerLanguage(const std::string& config) const;
/** Does this target have a GNU implib to convert to MS format? */

12
Source/cmGlobVerificationManager.h
View File

@ -22,11 +22,11 @@
class cmGlobVerificationManager
{
protected:
///! Save verification script for given makefile.
///! Saves to output <path>/<CMakeFilesDirectory>/VerifyGlobs.cmake
//! Save verification script for given makefile.
//! Saves to output <path>/<CMakeFilesDirectory>/VerifyGlobs.cmake
bool SaveVerificationScript(const std::string& path);
///! Add an entry into the glob cache
//! Add an entry into the glob cache
void AddCacheEntry(bool recurse, bool listDirectories, bool followSymlinks,
const std::string& relative,
const std::string& expression,
@ -34,13 +34,13 @@ protected:
const std::string& variable,
const cmListFileBacktrace& bt);
///! Clear the glob cache for state reset.
//! Clear the glob cache for state reset.
void Reset();
///! Check targets should be written in generated build system.
//! Check targets should be written in generated build system.
bool DoWriteVerifyTarget() const;
///! Get the paths to the generated script and stamp files
//! Get the paths to the generated script and stamp files
std::string const& GetVerifyScript() const { return this->VerifyScript; }
std::string const& GetVerifyStamp() const { return this->VerifyStamp; }

2
Source/cmGlobalBorlandMakefileGenerator.cxx
View File

@ -34,7 +34,7 @@ void cmGlobalBorlandMakefileGenerator::EnableLanguage(
this->cmGlobalUnixMakefileGenerator3::EnableLanguage(l, mf, optional);
}
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* cmGlobalBorlandMakefileGenerator::CreateLocalGenerator(
cmMakefile* mf)
{

4
Source/cmGlobalBorlandMakefileGenerator.h
View File

@ -22,7 +22,7 @@ public:
cmGlobalBorlandMakefileGenerator>();
}
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalBorlandMakefileGenerator::GetActualName();
@ -32,7 +32,7 @@ public:
/** Get the documentation entry for this generator. */
static void GetDocumentation(cmDocumentationEntry& entry);
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* CreateLocalGenerator(cmMakefile* mf) override;
/**

22
Source/cmGlobalGenerator.h
View File

@ -86,13 +86,13 @@ struct GeneratedMakeCommand
class cmGlobalGenerator
{
public:
///! Free any memory allocated with the GlobalGenerator
//! Free any memory allocated with the GlobalGenerator
cmGlobalGenerator(cmake* cm);
virtual ~cmGlobalGenerator();
virtual cmLocalGenerator* CreateLocalGenerator(cmMakefile* mf);
///! Get the name for this generator
//! Get the name for this generator
virtual std::string GetName() const { return "Generic"; }
/** Check whether the given name matches the current generator. */
@ -236,7 +236,7 @@ public:
const std::string& native,
bool ignoreErrors);
///! Get the CMake instance
//! Get the CMake instance
cmake* GetCMakeInstance() const { return this->CMakeInstance; }
void SetConfiguredFilesPath(cmGlobalGenerator* gen);
@ -261,7 +261,7 @@ public:
void AddMakefile(cmMakefile* mf);
///! Set an generator for an "external makefile based project"
//! Set an generator for an "external makefile based project"
void SetExternalMakefileProjectGenerator(
cmExternalMakefileProjectGenerator* extraGenerator);
@ -290,19 +290,19 @@ public:
bool GetForceUnixPaths() const { return this->ForceUnixPaths; }
bool GetToolSupportsColor() const { return this->ToolSupportsColor; }
///! return the language for the given extension
//! return the language for the given extension
std::string GetLanguageFromExtension(const char* ext) const;
///! is an extension to be ignored
//! is an extension to be ignored
bool IgnoreFile(const char* ext) const;
///! What is the preference for linkers and this language (None or Preferred)
//! What is the preference for linkers and this language (None or Preferred)
int GetLinkerPreference(const std::string& lang) const;
///! What is the object file extension for a given source file?
//! What is the object file extension for a given source file?
std::string GetLanguageOutputExtension(cmSourceFile const&) const;
///! What is the configurations directory variable called?
//! What is the configurations directory variable called?
virtual const char* GetCMakeCFGIntDir() const { return "."; }
///! expand CFGIntDir for a configuration
//! expand CFGIntDir for a configuration
virtual std::string ExpandCFGIntDir(const std::string& str,
const std::string& config) const;
@ -318,7 +318,7 @@ public:
*/
virtual bool FindMakeProgram(cmMakefile*);
///! Find a target by name by searching the local generators.
//! Find a target by name by searching the local generators.
cmTarget* FindTarget(const std::string& name,
bool excludeAliases = false) const;

4
Source/cmGlobalGhsMultiGenerator.h
View File

@ -34,13 +34,13 @@ public:
return new cmGlobalGeneratorSimpleFactory<cmGlobalGhsMultiGenerator>();
}
///! create the correct local generator
//! create the correct local generator
cmLocalGenerator* CreateLocalGenerator(cmMakefile* mf) override;
/// @return the name of this generator.
static std::string GetActualName() { return "Green Hills MULTI"; }
///! Get the name for this generator
//! Get the name for this generator
std::string GetName() const override { return GetActualName(); }
/// Overloaded methods. @see cmGlobalGenerator::GetDocumentation()

2
Source/cmGlobalJOMMakefileGenerator.h
View File

@ -20,7 +20,7 @@ public:
{
return new cmGlobalGeneratorSimpleFactory<cmGlobalJOMMakefileGenerator>();
}
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalJOMMakefileGenerator::GetActualName();

2
Source/cmGlobalMSYSMakefileGenerator.h
View File

@ -19,7 +19,7 @@ public:
return new cmGlobalGeneratorSimpleFactory<cmGlobalMSYSMakefileGenerator>();
}
///! Get the name for the generator.
//! Get the name for the generator.
virtual std::string GetName() const
{
return cmGlobalMSYSMakefileGenerator::GetActualName();

2
Source/cmGlobalMinGWMakefileGenerator.h
View File

@ -19,7 +19,7 @@ public:
return new cmGlobalGeneratorSimpleFactory<
cmGlobalMinGWMakefileGenerator>();
}
///! Get the name for the generator.
//! Get the name for the generator.
virtual std::string GetName() const
{
return cmGlobalMinGWMakefileGenerator::GetActualName();

2
Source/cmGlobalNMakeMakefileGenerator.h
View File

@ -21,7 +21,7 @@ public:
return new cmGlobalGeneratorSimpleFactory<
cmGlobalNMakeMakefileGenerator>();
}
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalNMakeMakefileGenerator::GetActualName();

2
Source/cmGlobalUnixMakefileGenerator3.cxx
View File

@ -57,7 +57,7 @@ void cmGlobalUnixMakefileGenerator3::EnableLanguage(
}
}
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* cmGlobalUnixMakefileGenerator3::CreateLocalGenerator(
cmMakefile* mf)
{

2
Source/cmGlobalUnixMakefileGenerator3.h
View File

@ -67,7 +67,7 @@ public:
cmGlobalUnixMakefileGenerator3>();
}
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalUnixMakefileGenerator3::GetActualName();

2
Source/cmGlobalVisualStudio10Generator.cxx
View File

@ -509,7 +509,7 @@ std::string cmGlobalVisualStudio10Generator::SelectWindowsCEToolset() const
return "";
}
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* cmGlobalVisualStudio10Generator::CreateLocalGenerator(
cmMakefile* mf)
{

2
Source/cmGlobalVisualStudio10Generator.h
View File

@ -29,7 +29,7 @@ public:
std::vector<std::string> const& makeOptions =
std::vector<std::string>()) override;
///! create the correct local generator
//! create the correct local generator
cmLocalGenerator* CreateLocalGenerator(cmMakefile* mf) override;
/**

2
Source/cmGlobalVisualStudio7Generator.cxx
View File

@ -248,7 +248,7 @@ cmGlobalVisualStudio7Generator::GenerateBuildCommand(
return makeCommands;
}
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* cmGlobalVisualStudio7Generator::CreateLocalGenerator(
cmMakefile* mf)
{

6
Source/cmGlobalVisualStudio7Generator.h
View File

@ -20,7 +20,7 @@ class cmGlobalVisualStudio7Generator : public cmGlobalVisualStudioGenerator
public:
~cmGlobalVisualStudio7Generator();
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* CreateLocalGenerator(cmMakefile* mf) override;
#if defined(CMAKE_BUILD_WITH_CMAKE)
@ -64,7 +64,7 @@ public:
*/
virtual void OutputSLNFile();
///! Lookup a stored GUID or compute one deterministically.
//! Lookup a stored GUID or compute one deterministically.
std::string GetGUID(std::string const& name);
/** Append the subdirectory for the given configuration. */
@ -73,7 +73,7 @@ public:
const std::string& suffix,
std::string& dir) override;
///! What is the configurations directory variable called?
//! What is the configurations directory variable called?
const char* GetCMakeCFGIntDir() const override
{
return "$(ConfigurationName)";

2
Source/cmGlobalVisualStudio8Generator.h
View File

@ -13,7 +13,7 @@
class cmGlobalVisualStudio8Generator : public cmGlobalVisualStudio71Generator
{
public:
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override { return this->Name; }
/** Get the name of the main stamp list file. */

2
Source/cmGlobalWatcomWMakeGenerator.h
View File

@ -29,7 +29,7 @@ public:
{
return new cmGlobalGeneratorSimpleFactory<cmGlobalWatcomWMakeGenerator>();
}
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalWatcomWMakeGenerator::GetActualName();

2
Source/cmGlobalXCodeGenerator.cxx
View File

@ -389,7 +389,7 @@ cmGlobalXCodeGenerator::GenerateBuildCommand(
return { std::move(makeCommand) };
}
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* cmGlobalXCodeGenerator::CreateLocalGenerator(cmMakefile* mf)
{
return new cmLocalXCodeGenerator(this, mf);

8
Source/cmGlobalXCodeGenerator.h
View File

@ -36,7 +36,7 @@ public:
unsigned int version_number);
static cmGlobalGeneratorFactory* NewFactory();
///! Get the name for the generator.
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalXCodeGenerator::GetActualName();
@ -46,7 +46,7 @@ public:
/** Get the documentation entry for this generator. */
static void GetDocumentation(cmDocumentationEntry& entry);
///! Create a local generator appropriate to this Global Generator
//! Create a local generator appropriate to this Global Generator
cmLocalGenerator* CreateLocalGenerator(cmMakefile* mf) override;
/**
@ -81,9 +81,9 @@ public:
bool FindMakeProgram(cmMakefile*) override;
///! What is the configurations directory variable called?
//! What is the configurations directory variable called?
const char* GetCMakeCFGIntDir() const override;
///! expand CFGIntDir
//! expand CFGIntDir
std::string ExpandCFGIntDir(const std::string& str,
const std::string& config) const override;

2
Source/cmLoadCommandCommand.cxx
View File

@ -33,7 +33,7 @@ public:
this->info.CAPI = &cmStaticCAPI;
}
///! clean up any memory allocated by the plugin
//! clean up any memory allocated by the plugin
~cmLoadedCommand() override;
/**

12
Source/cmLocalGenerator.h
View File

@ -76,13 +76,13 @@ public:
bool IsRootMakefile() const;
///! Get the makefile for this generator
//! Get the makefile for this generator
cmMakefile* GetMakefile() { return this->Makefile; }
///! Get the makefile for this generator, const version
//! Get the makefile for this generator, const version
const cmMakefile* GetMakefile() const { return this->Makefile; }
///! Get the GlobalGenerator this is associated with
//! Get the GlobalGenerator this is associated with
cmGlobalGenerator* GetGlobalGenerator() { return this->GlobalGenerator; }
const cmGlobalGenerator* GetGlobalGenerator() const
{
@ -118,7 +118,7 @@ public:
void AddCompilerRequirementFlag(std::string& flags,
cmGeneratorTarget const* target,
const std::string& lang);
///! Append flags to a string.
//! Append flags to a string.
virtual void AppendFlags(std::string& flags,
const std::string& newFlags) const;
virtual void AppendFlags(std::string& flags, const char* newFlags) const;
@ -131,7 +131,7 @@ public:
cmGeneratorTarget* target,
const std::string& config,
const std::string& lang);
///! Get the include flags for the current makefile and language
//! Get the include flags for the current makefile and language
std::string GetIncludeFlags(const std::vector<std::string>& includes,
cmGeneratorTarget* target,
const std::string& lang,
@ -403,7 +403,7 @@ public:
const std::string& prop);
protected:
///! put all the libraries for a target on into the given stream
//! put all the libraries for a target on into the given stream
void OutputLinkLibraries(cmComputeLinkInformation* pcli,
cmLinkLineComputer* linkLineComputer,
std::string& linkLibraries,

2
Source/cmLocalVisualStudio10Generator.h
View File

@ -21,7 +21,7 @@ class cmMakefile;
class cmLocalVisualStudio10Generator : public cmLocalVisualStudio7Generator
{
public:
///! Set cache only and recurse to false by default.
//! Set cache only and recurse to false by default.
cmLocalVisualStudio10Generator(cmGlobalGenerator* gg, cmMakefile* mf);
virtual ~cmLocalVisualStudio10Generator();

2
Source/cmLocalVisualStudio7Generator.h
View File

@ -43,7 +43,7 @@ public:
class cmLocalVisualStudio7Generator : public cmLocalVisualStudioGenerator
{
public:
///! Set cache only and recurse to false by default.
//! Set cache only and recurse to false by default.
cmLocalVisualStudio7Generator(cmGlobalGenerator* gg, cmMakefile* mf);
virtual ~cmLocalVisualStudio7Generator();

2
Source/cmLocalXCodeGenerator.h
View File

@ -24,7 +24,7 @@ class cmSourceFile;
class cmLocalXCodeGenerator : public cmLocalGenerator
{
public:
///! Set cache only and recurse to false by default.
//! Set cache only and recurse to false by default.
cmLocalXCodeGenerator(cmGlobalGenerator* gg, cmMakefile* mf);
~cmLocalXCodeGenerator() override;

16
Source/cmMakefile.h
View File

@ -257,7 +257,7 @@ public:
* can be used in CMake to refer to lists, directories, etc.
*/
void AddDefinition(const std::string& name, const char* value);
///! Add a definition to this makefile and the global cmake cache.
//! Add a definition to this makefile and the global cmake cache.
void AddCacheDefinition(const std::string& name, const char* value,
const char* doc, cmStateEnums::CacheEntryType type,
bool force = false);
@ -272,7 +272,7 @@ public:
* for cache entries, and will only affect the current makefile.
*/
void RemoveDefinition(const std::string& name);
///! Remove a definition from the cache.
//! Remove a definition from the cache.
void RemoveCacheDefinition(const std::string& name);
/**
@ -548,7 +548,7 @@ public:
{
return this->ListFiles;
}
///! When the file changes cmake will be re-run from the build system.
//! When the file changes cmake will be re-run from the build system.
void AddCMakeDependFile(const std::string& file)
{
this->ListFiles.push_back(file);
@ -626,7 +626,7 @@ public:
bool ExecuteCommand(const cmListFileFunction& lff,
cmExecutionStatus& status);
///! Enable support for named language, if nil then all languages are
//! Enable support for named language, if nil then all languages are
/// enabled.
void EnableLanguage(std::vector<std::string> const& languages,
bool optional);
@ -641,7 +641,7 @@ public:
cmVariableWatch* GetVariableWatch() const;
#endif
///! Display progress or status message.
//! Display progress or status message.
void DisplayStatus(const std::string&, float) const;
/**
@ -677,7 +677,7 @@ public:
*/
cmSourceFile* GetSourceFileWithOutput(const std::string& outName) const;
///! Add a new cmTest to the list of tests for this makefile.
//! Add a new cmTest to the list of tests for this makefile.
cmTest* CreateTest(const std::string& testName);
/** Get a cmTest pointer for a given test name, if the name is
@ -701,7 +701,7 @@ public:
std::string GetModulesFile(const std::string& name, bool& system) const;
///! Set/Get a property of this directory
//! Set/Get a property of this directory
void SetProperty(const std::string& prop, const char* value);
void AppendProperty(const std::string& prop, const char* value,
bool asString = false);
@ -710,7 +710,7 @@ public:
bool GetPropertyAsBool(const std::string& prop) const;
std::vector<std::string> GetPropertyKeys() const;
///! Initialize a makefile from its parent
//! Initialize a makefile from its parent
void InitializeFromParent(cmMakefile* parent);
void AddInstallGenerator(cmInstallGenerator* g)

2
Source/cmOutputConverter.h
View File

@ -27,7 +27,7 @@ public:
std::string ConvertDirectorySeparatorsForShell(
const std::string& source) const;
///! for existing files convert to output path and short path if spaces
//! for existing files convert to output path and short path if spaces
std::string ConvertToOutputForExisting(const std::string& remote,
OutputFormat format = SHELL) const;

6
Source/cmPolicies.cxx
View File

@ -299,7 +299,7 @@ bool cmPolicies::GetPolicyID(const char* id, cmPolicies::PolicyID& pid)
return stringToId(id, pid);
}
///! return a warning string for a given policy
//! return a warning string for a given policy
std::string cmPolicies::GetPolicyWarning(cmPolicies::PolicyID id)
{
std::ostringstream msg;
@ -333,7 +333,7 @@ std::string cmPolicies::GetPolicyDeprecatedWarning(cmPolicies::PolicyID id)
return msg.str();
}
///! return an error string for when a required policy is unspecified
//! return an error string for when a required policy is unspecified
std::string cmPolicies::GetRequiredPolicyError(cmPolicies::PolicyID id)
{
std::ostringstream error;
@ -359,7 +359,7 @@ std::string cmPolicies::GetRequiredPolicyError(cmPolicies::PolicyID id)
return error.str();
}
///! Get the default status for a policy
//! Get the default status for a policy
cmPolicies::PolicyStatus cmPolicies::GetPolicyStatus(
cmPolicies::PolicyID /*unused*/)
{

12
Source/cmPolicies.h
View File

@ -332,27 +332,27 @@ public:
CMPCOUNT
};
///! convert a string policy ID into a number
//! convert a string policy ID into a number
static bool GetPolicyID(const char* id, /* out */ cmPolicies::PolicyID& pid);
///! Get the default status for a policy
//! Get the default status for a policy
static cmPolicies::PolicyStatus GetPolicyStatus(cmPolicies::PolicyID id);
///! Set a policy level for this listfile
//! Set a policy level for this listfile
static bool ApplyPolicyVersion(cmMakefile* mf,
std::string const& version_min,
std::string const& version_max);
static bool ApplyPolicyVersion(cmMakefile* mf, unsigned int majorVer,
unsigned int minorVer, unsigned int patchVer);
///! return a warning string for a given policy
//! return a warning string for a given policy
static std::string GetPolicyWarning(cmPolicies::PolicyID id);
static std::string GetPolicyDeprecatedWarning(cmPolicies::PolicyID id);
///! return an error string for when a required policy is unspecified
//! return an error string for when a required policy is unspecified
static std::string GetRequiredPolicyError(cmPolicies::PolicyID id);
///! return an error string for when a required policy is unspecified
//! return an error string for when a required policy is unspecified
static std::string GetRequiredAlwaysPolicyError(cmPolicies::PolicyID id);
/** Represent a set of policy values. */

8
Source/cmSourceFile.h
View File

@ -44,13 +44,13 @@ public:
cmCustomCommand const* GetCustomCommand() const;
void SetCustomCommand(cmCustomCommand* cc);
///! Set/Get a property of this source file
//! Set/Get a property of this source file
void SetProperty(const std::string& prop, const char* value);
void AppendProperty(const std::string& prop, const char* value,
bool asString = false);
///! Might return a nullptr if the property is not set or invalid
//! Might return a nullptr if the property is not set or invalid
const char* GetProperty(const std::string& prop) const;
///! Always returns a valid pointer
//! Always returns a valid pointer
const char* GetSafeProperty(const std::string& prop) const;
bool GetPropertyAsBool(const std::string& prop) const;
@ -58,7 +58,7 @@ public:
command like get_property or get_source_file_property. */
const char* GetPropertyForUser(const std::string& prop);
///! Checks is the GENERATED property is set and true
//! Checks is the GENERATED property is set and true
/// @return Equivalent to GetPropertyAsBool("GENERATED")
bool GetIsGenerated() const { return this->IsGenerated; }

2
Source/cmState.h
View File

@ -107,7 +107,7 @@ public:
void RemoveCacheEntryProperty(std::string const& key,
std::string const& propertyName);
///! Break up a line like VAR:type="value" into var, type and value
//! Break up a line like VAR:type="value" into var, type and value
static bool ParseCacheEntry(const std::string& entry, std::string& var,
std::string& value,
cmStateEnums::CacheEntryType& type);

22
Source/cmSystemTools.h
View File

@ -45,7 +45,7 @@ public:
static void ExpandRegistryValues(std::string& source,
KeyWOW64 view = KeyWOW64_Default);
///! Escape quotes in a string.
//! Escape quotes in a string.
static std::string EscapeQuotes(const std::string& str);
/** Map help document name to file name. */
@ -78,11 +78,11 @@ public:
using OutputCallback = std::function<void(std::string const&)>;
///! Send a string to stdout
//! Send a string to stdout
static void Stdout(const std::string& s);
static void SetStdoutCallback(OutputCallback f);
///! Send a string to stderr
//! Send a string to stderr
static void Stderr(const std::string& s);
static void SetStderrCallback(OutputCallback f);
@ -90,25 +90,25 @@ public:
static void SetInterruptCallback(InterruptCallback f);
static bool GetInterruptFlag();
///! Return true if there was an error at any point.
//! Return true if there was an error at any point.
static bool GetErrorOccuredFlag()
{
return cmSystemTools::s_ErrorOccured ||
cmSystemTools::s_FatalErrorOccured || GetInterruptFlag();
}
///! If this is set to true, cmake stops processing commands.
//! If this is set to true, cmake stops processing commands.
static void SetFatalErrorOccured()
{
cmSystemTools::s_FatalErrorOccured = true;
}
static void SetErrorOccured() { cmSystemTools::s_ErrorOccured = true; }
///! Return true if there was an error at any point.
//! Return true if there was an error at any point.
static bool GetFatalErrorOccured()
{
return cmSystemTools::s_FatalErrorOccured || GetInterruptFlag();
}
///! Set the error occurred flag and fatal error back to false
//! Set the error occurred flag and fatal error back to false
static void ResetErrorOccuredFlag()
{
cmSystemTools::s_FatalErrorOccured = false;
@ -138,9 +138,9 @@ public:
static bool IsOff(const char* val);
static bool IsOff(const std::string& val);
///! Return true if value is NOTFOUND or ends in -NOTFOUND.
//! Return true if value is NOTFOUND or ends in -NOTFOUND.
static bool IsNOTFOUND(const char* value);
///! Return true if the path is a framework
//! Return true if the path is a framework
static bool IsPathToFramework(const std::string& value);
static bool DoesFileExistWithExtensions(
@ -177,14 +177,14 @@ public:
static bool RenameFile(const std::string& oldname,
const std::string& newname);
///! Compute the hash of a file
//! Compute the hash of a file
static std::string ComputeFileHash(const std::string& source,
cmCryptoHash::Algo algo);
/** Compute the md5sum of a string. */
static std::string ComputeStringMD5(const std::string& input);
///! Get the SHA thumbprint for a certificate file
//! Get the SHA thumbprint for a certificate file
static std::string ComputeCertificateThumbprint(const std::string& source);
/**

2
Source/cmTarget.cxx
View File

@ -34,7 +34,7 @@
#include "cmTargetPropertyComputer.h"
#include "cmake.h"
///! Append all elements from the second container to the first container
//! Append all elements from the second container to the first container
template <class C, class R>
static inline void CApp(C& container, R const& range)
{

42
Source/cmTarget.h
View File

@ -59,22 +59,22 @@ public:
cmTarget& operator=(cmTarget const&) = delete;
cmTarget& operator=(cmTarget&&) noexcept;
///! Return the type of target.
//! Return the type of target.
cmStateEnums::TargetType GetType() const;
///! Get the cmMakefile that owns this target.
//! Get the cmMakefile that owns this target.
cmMakefile* GetMakefile() const;
///! Return the global generator.
//! Return the global generator.
cmGlobalGenerator* GetGlobalGenerator() const;
///! Set/Get the name of the target
//! Set/Get the name of the target
const std::string& GetName() const;
///! Get the policy map
//! Get the policy map
cmPolicies::PolicyMap const& GetPolicyMap() const;
///! Get policy status
//! Get policy status
cmPolicies::PolicyStatus GetPolicyStatus(cmPolicies::PolicyID policy) const;
#define DECLARE_TARGET_POLICY(POLICY) \
@ -87,30 +87,30 @@ public:
#undef DECLARE_TARGET_POLICY
///! Get the list of the PRE_BUILD custom commands for this target
//! Get the list of the PRE_BUILD custom commands for this target
std::vector<cmCustomCommand> const& GetPreBuildCommands() const;
void AddPreBuildCommand(cmCustomCommand const& cmd);
///! Get the list of the PRE_LINK custom commands for this target
//! Get the list of the PRE_LINK custom commands for this target
std::vector<cmCustomCommand> const& GetPreLinkCommands() const;
void AddPreLinkCommand(cmCustomCommand const& cmd);
///! Get the list of the POST_BUILD custom commands for this target
//! Get the list of the POST_BUILD custom commands for this target
std::vector<cmCustomCommand> const& GetPostBuildCommands() const;
void AddPostBuildCommand(cmCustomCommand const& cmd);
///! Add sources to the target.
//! Add sources to the target.
void AddSources(std::vector<std::string> const& srcs);
void AddTracedSources(std::vector<std::string> const& srcs);
cmSourceFile* AddSourceCMP0049(const std::string& src);
cmSourceFile* AddSource(const std::string& src, bool before = false);
///! how we identify a library, by name and type
//! how we identify a library, by name and type
typedef std::pair<std::string, cmTargetLinkLibraryType> LibraryID;
typedef std::vector<LibraryID> LinkLibraryVectorType;
LinkLibraryVectorType const& GetOriginalLinkLibraries() const;
///! Clear the dependency information recorded for this target, if any.
//! Clear the dependency information recorded for this target, if any.
void ClearDependencyInformation(cmMakefile& mf);
void AddLinkLibrary(cmMakefile& mf, const std::string& lib,
@ -159,23 +159,23 @@ public:
* commands. It is not a full path nor does it have an extension.
*/
void AddUtility(std::string const& name, cmMakefile* mf = nullptr);
///! Get the utilities used by this target
//! Get the utilities used by this target
std::set<BT<std::string>> const& GetUtilities() const;
///! Set/Get a property of this target file
//! Set/Get a property of this target file
void SetProperty(const std::string& prop, const char* value);
void AppendProperty(const std::string& prop, const char* value,
bool asString = false);
///! Might return a nullptr if the property is not set or invalid
//! Might return a nullptr if the property is not set or invalid
const char* GetProperty(const std::string& prop) const;
///! Always returns a valid pointer
//! Always returns a valid pointer
const char* GetSafeProperty(const std::string& prop) const;
bool GetPropertyAsBool(const std::string& prop) const;
void CheckProperty(const std::string& prop, cmMakefile* context) const;
const char* GetComputedProperty(const std::string& prop,
cmMessenger* messenger,
cmListFileBacktrace const& context) const;
///! Get all properties
//! Get all properties
cmPropertyMap const& GetProperties() const;
bool IsImported() const;
@ -184,16 +184,16 @@ public:
bool GetMappedConfig(std::string const& desired_config, const char** loc,
const char** imp, std::string& suffix) const;
///! Return whether this target is an executable with symbol exports enabled.
//! Return whether this target is an executable with symbol exports enabled.
bool IsExecutableWithExports() const;
///! Return whether this target is a shared library Framework on Apple.
//! Return whether this target is a shared library Framework on Apple.
bool IsFrameworkOnApple() const;
///! Return whether this target is an executable Bundle on Apple.
//! Return whether this target is an executable Bundle on Apple.
bool IsAppBundleOnApple() const;
///! Get a backtrace from the creation of the target.
//! Get a backtrace from the creation of the target.
cmListFileBacktrace const& GetBacktrace() const;
void InsertInclude(std::string const& entry, cmListFileBacktrace const& bt,

4
Source/cmTest.h
View File

@ -26,14 +26,14 @@ public:
cmTest(cmMakefile* mf);
~cmTest();
///! Set the test name
//! Set the test name
void SetName(const std::string& name);
std::string GetName() const { return this->Name; }
void SetCommand(std::vector<std::string> const& command);
std::vector<std::string> const& GetCommand() const { return this->Command; }
///! Set/Get a property of this source file
//! Set/Get a property of this source file
void SetProperty(const std::string& prop, const char* value);
void AppendProperty(const std::string& prop, const char* value,
bool asString = false);

48
Source/cmake.h
View File

@ -162,7 +162,7 @@ public:
int Configure();
int ActualConfigure();
///! Break up a line like VAR:type="value" into var, type and value
//! Break up a line like VAR:type="value" into var, type and value
static bool ParseCacheEntry(const std::string& entry, std::string& var,
std::string& value,
cmStateEnums::CacheEntryType& type);
@ -176,40 +176,40 @@ public:
bool DeleteCache(const std::string& path);
void PreLoadCMakeFiles();
///! Create a GlobalGenerator
//! Create a GlobalGenerator
cmGlobalGenerator* CreateGlobalGenerator(const std::string& name);
///! Return the global generator assigned to this instance of cmake
//! Return the global generator assigned to this instance of cmake
cmGlobalGenerator* GetGlobalGenerator() { return this->GlobalGenerator; }
///! Return the global generator assigned to this instance of cmake, const
//! Return the global generator assigned to this instance of cmake, const
const cmGlobalGenerator* GetGlobalGenerator() const
{
return this->GlobalGenerator;
}
///! Return the full path to where the CMakeCache.txt file should be.
//! Return the full path to where the CMakeCache.txt file should be.
static std::string FindCacheFile(const std::string& binaryDir);
///! Return the global generator assigned to this instance of cmake
//! Return the global generator assigned to this instance of cmake
void SetGlobalGenerator(cmGlobalGenerator*);
///! Get the names of the current registered generators
//! Get the names of the current registered generators
void GetRegisteredGenerators(std::vector<GeneratorInfo>& generators,
bool includeNamesWithPlatform = true) const;
///! Set the name of the selected generator-specific instance.
//! Set the name of the selected generator-specific instance.
void SetGeneratorInstance(std::string const& instance)
{
this->GeneratorInstance = instance;
}
///! Set the name of the selected generator-specific platform.
//! Set the name of the selected generator-specific platform.
void SetGeneratorPlatform(std::string const& ts)
{
this->GeneratorPlatform = ts;
}
///! Set the name of the selected generator-specific toolset.
//! Set the name of the selected generator-specific toolset.
void SetGeneratorToolset(std::string const& ts)
{
this->GeneratorToolset = ts;
@ -244,7 +244,7 @@ public:
* Given a variable name, return its value (as a string).
*/
const char* GetCacheDefinition(const std::string&) const;
///! Add an entry into the cache
//! Add an entry into the cache
void AddCacheEntry(const std::string& key, const char* value,
const char* helpString, int type);
@ -263,14 +263,14 @@ public:
*/
int GetSystemInformation(std::vector<std::string>&);
///! Parse command line arguments
//! Parse command line arguments
void SetArgs(const std::vector<std::string>& args);
///! Is this cmake running as a result of a TRY_COMPILE command
//! Is this cmake running as a result of a TRY_COMPILE command
bool GetIsInTryCompile() const;
void SetIsInTryCompile(bool b);
///! Parse command line arguments that might set cache values
//! Parse command line arguments that might set cache values
bool SetCacheArgs(const std::vector<std::string>&);
using ProgressCallbackType = std::function<void(const std::string&, float)>;
@ -283,24 +283,24 @@ public:
*/
void SetProgressCallback(ProgressCallbackType f);
///! this is called by generators to update the progress
//! this is called by generators to update the progress
void UpdateProgress(const std::string& msg, float prog);
#if defined(CMAKE_BUILD_WITH_CMAKE)
///! Get the variable watch object
//! Get the variable watch object
cmVariableWatch* GetVariableWatch() { return this->VariableWatch; }
#endif
std::vector<cmDocumentationEntry> GetGeneratorsDocumentation();
///! Set/Get a property of this target file
//! Set/Get a property of this target file
void SetProperty(const std::string& prop, const char* value);
void AppendProperty(const std::string& prop, const char* value,
bool asString = false);
const char* GetProperty(const std::string& prop);
bool GetPropertyAsBool(const std::string& prop);
///! Get or create an cmInstalledFile instance and return a pointer to it
//! Get or create an cmInstalledFile instance and return a pointer to it
cmInstalledFile* GetOrCreateInstalledFile(cmMakefile* mf,
const std::string& name);
@ -311,13 +311,13 @@ public:
return this->InstalledFiles;
}
///! Do all the checks before running configure
//! Do all the checks before running configure
int DoPreConfigureChecks();
void SetWorkingMode(WorkingMode mode) { this->CurrentWorkingMode = mode; }
WorkingMode GetWorkingMode() { return this->CurrentWorkingMode; }
///! Debug the try compile stuff by not deleting the files
//! Debug the try compile stuff by not deleting the files
bool GetDebugTryCompile() { return this->DebugTryCompile; }
void DebugTryCompileOn() { this->DebugTryCompile = true; }
@ -423,13 +423,13 @@ public:
MessageType t, std::string const& text,
cmListFileBacktrace const& backtrace = cmListFileBacktrace()) const;
///! run the --build option
//! run the --build option
int Build(int jobs, const std::string& dir,
const std::vector<std::string>& targets, const std::string& config,
const std::vector<std::string>& nativeOptions, bool clean,
bool verbose);
///! run the --open option
//! run the --open option
bool Open(const std::string& dir, bool dryRun);
void UnwatchUnusedCli(const std::string& var);
@ -462,12 +462,12 @@ protected:
std::string GeneratorPlatform;
std::string GeneratorToolset;
///! read in a cmake list file to initialize the cache
//! read in a cmake list file to initialize the cache
void ReadListFile(const std::vector<std::string>& args,
const std::string& path);
bool FindPackage(const std::vector<std::string>& args);
///! Check if CMAKE_CACHEFILE_DIR is set. If it is not, delete the log file.
//! Check if CMAKE_CACHEFILE_DIR is set. If it is not, delete the log file.
/// If it is set, truncate it to 50kb
void TruncateOutputLog(const char* fname);