doxygen: remove a few comments

These comments were either wrong or non-informative.
Replace some of them by brief comments
This commit is contained in:
Yury G. Kudryashov 2012-02-28 01:54:43 +04:00
parent 477459010f
commit 937bb4bebf
6 changed files with 5 additions and 55 deletions

View File

@ -16,11 +16,6 @@
#include "cmFunctionBlocker.h" #include "cmFunctionBlocker.h"
#include "cmListFileCache.h" #include "cmListFileCache.h"
/** \class cmForEachFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmForEachFunctionBlocker : public cmFunctionBlocker class cmForEachFunctionBlocker : public cmFunctionBlocker
{ {
public: public:
@ -37,11 +32,7 @@ private:
int Depth; int Depth;
}; };
/** \class cmForEachCommand /// Starts foreach() ... endforeach() block
* \brief starts an if block
*
* cmForEachCommand starts an if block
*/
class cmForEachCommand : public cmCommand class cmForEachCommand : public cmCommand
{ {
public: public:

View File

@ -17,11 +17,6 @@
#include "cmListFileCache.h" #include "cmListFileCache.h"
class cmMakefile; class cmMakefile;
/** \class cmFunctionBlocker
* \brief A class that defines an interface for blocking cmake functions
*
* This is the superclass for any classes that need to block a cmake function
*/
class cmFunctionBlocker class cmFunctionBlocker
{ {
public: public:

View File

@ -15,11 +15,6 @@
#include "cmCommand.h" #include "cmCommand.h"
#include "cmFunctionBlocker.h" #include "cmFunctionBlocker.h"
/** \class cmFunctionFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmFunctionFunctionBlocker : public cmFunctionBlocker class cmFunctionFunctionBlocker : public cmFunctionBlocker
{ {
public: public:
@ -35,11 +30,7 @@ public:
int Depth; int Depth;
}; };
/** \class cmFunctionCommand /// Starts function() ... endfunction() block
* \brief starts an if block
*
* cmFunctionCommand starts an if block
*/
class cmFunctionCommand : public cmCommand class cmFunctionCommand : public cmCommand
{ {
public: public:

View File

@ -15,11 +15,6 @@
#include "cmCommand.h" #include "cmCommand.h"
#include "cmFunctionBlocker.h" #include "cmFunctionBlocker.h"
/** \class cmIfFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmIfFunctionBlocker : public cmFunctionBlocker class cmIfFunctionBlocker : public cmFunctionBlocker
{ {
public: public:
@ -39,11 +34,7 @@ public:
unsigned int ScopeDepth; unsigned int ScopeDepth;
}; };
/** \class cmIfCommand /// Starts an if block
* \brief starts an if block
*
* cmIfCommand starts an if block
*/
class cmIfCommand : public cmCommand class cmIfCommand : public cmCommand
{ {
public: public:

View File

@ -15,11 +15,6 @@
#include "cmCommand.h" #include "cmCommand.h"
#include "cmFunctionBlocker.h" #include "cmFunctionBlocker.h"
/** \class cmMacroFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmMacroFunctionBlocker : public cmFunctionBlocker class cmMacroFunctionBlocker : public cmFunctionBlocker
{ {
public: public:
@ -35,11 +30,7 @@ public:
int Depth; int Depth;
}; };
/** \class cmMacroCommand /// Starts macro() ... endmacro() block
* \brief starts an if block
*
* cmMacroCommand starts an if block
*/
class cmMacroCommand : public cmCommand class cmMacroCommand : public cmCommand
{ {
public: public:

View File

@ -16,11 +16,6 @@
#include "cmFunctionBlocker.h" #include "cmFunctionBlocker.h"
#include "cmListFileCache.h" #include "cmListFileCache.h"
/** \class cmWhileFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmWhileFunctionBlocker : public cmFunctionBlocker class cmWhileFunctionBlocker : public cmFunctionBlocker
{ {
public: public:
@ -37,11 +32,7 @@ private:
int Depth; int Depth;
}; };
/** \class cmWhileCommand /// \brief Starts a while loop
* \brief starts a while loop
*
* cmWhileCommand starts a while loop
*/
class cmWhileCommand : public cmCommand class cmWhileCommand : public cmCommand
{ {
public: public: