Commit 735c6f39 authored by Sebastian Holtermann's avatar Sebastian Holtermann

Fix invalid ///! doxygen comment line starts

In various places `///!` was used to start a comment line.  This is not valid
Doygen syntax.  This patch replaces `///!` comment starts with `//!`.
parent 11475cc5
......@@ -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);
......
......@@ -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);
};
......
......@@ -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();
......
......@@ -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
......
......@@ -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,
......
......@@ -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);
......
......@@ -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;
......
......@@ -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? */
......
......@@ -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; }
......
......@@ -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)
{
......
......@@ -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;
/**
......
......@@ -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;
......
......@@ -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()
......
......@@ -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();
......
......@@ -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();
......
......@@ -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();
......
......@@ -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();
......
......@@ -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)
{
......
......@@ -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();
......
......@@ -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)
{
......
......@@ -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;
/**
......
......@@ -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)
{
......
......@@ -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)";
......
......@@ -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. */
......
......@@ -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();
......
......@@ -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);
......
......@@ -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;
......
......@@ -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;
/**
......
......@@ -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: