summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYury G. Kudryashov <urkud.urkud@gmail.com>2012-02-27 21:54:43 (GMT)
committerYury G. Kudryashov <urkud.urkud@gmail.com>2012-02-29 22:33:13 (GMT)
commit937bb4bebf560fddeb2a1438939fd50d177ae2bf (patch)
tree8fb6318746f8a27277c32df8c92e2df92ef0bfce
parent477459010f78d0d6d563080466a63490b6b99eb9 (diff)
downloadCMake-937bb4bebf560fddeb2a1438939fd50d177ae2bf.zip
CMake-937bb4bebf560fddeb2a1438939fd50d177ae2bf.tar.gz
CMake-937bb4bebf560fddeb2a1438939fd50d177ae2bf.tar.bz2
doxygen: remove a few comments
These comments were either wrong or non-informative. Replace some of them by brief comments
-rw-r--r--Source/cmForEachCommand.h11
-rw-r--r--Source/cmFunctionBlocker.h5
-rw-r--r--Source/cmFunctionCommand.h11
-rw-r--r--Source/cmIfCommand.h11
-rw-r--r--Source/cmMacroCommand.h11
-rw-r--r--Source/cmWhileCommand.h11
6 files changed, 5 insertions, 55 deletions
diff --git a/Source/cmForEachCommand.h b/Source/cmForEachCommand.h
index 026fd31..e702173 100644
--- a/Source/cmForEachCommand.h
+++ b/Source/cmForEachCommand.h
@@ -16,11 +16,6 @@
#include "cmFunctionBlocker.h"
#include "cmListFileCache.h"
-/** \class cmForEachFunctionBlocker
- * \brief subclass of function blocker
- *
- *
- */
class cmForEachFunctionBlocker : public cmFunctionBlocker
{
public:
@@ -37,11 +32,7 @@ private:
int Depth;
};
-/** \class cmForEachCommand
- * \brief starts an if block
- *
- * cmForEachCommand starts an if block
- */
+/// Starts foreach() ... endforeach() block
class cmForEachCommand : public cmCommand
{
public:
diff --git a/Source/cmFunctionBlocker.h b/Source/cmFunctionBlocker.h
index c3b29e1..9ee0b5c 100644
--- a/Source/cmFunctionBlocker.h
+++ b/Source/cmFunctionBlocker.h
@@ -17,11 +17,6 @@
#include "cmListFileCache.h"
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
{
public:
diff --git a/Source/cmFunctionCommand.h b/Source/cmFunctionCommand.h
index a169244..9873964 100644
--- a/Source/cmFunctionCommand.h
+++ b/Source/cmFunctionCommand.h
@@ -15,11 +15,6 @@
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
-/** \class cmFunctionFunctionBlocker
- * \brief subclass of function blocker
- *
- *
- */
class cmFunctionFunctionBlocker : public cmFunctionBlocker
{
public:
@@ -35,11 +30,7 @@ public:
int Depth;
};
-/** \class cmFunctionCommand
- * \brief starts an if block
- *
- * cmFunctionCommand starts an if block
- */
+/// Starts function() ... endfunction() block
class cmFunctionCommand : public cmCommand
{
public:
diff --git a/Source/cmIfCommand.h b/Source/cmIfCommand.h
index 4996bc4..f412442 100644
--- a/Source/cmIfCommand.h
+++ b/Source/cmIfCommand.h
@@ -15,11 +15,6 @@
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
-/** \class cmIfFunctionBlocker
- * \brief subclass of function blocker
- *
- *
- */
class cmIfFunctionBlocker : public cmFunctionBlocker
{
public:
@@ -39,11 +34,7 @@ public:
unsigned int ScopeDepth;
};
-/** \class cmIfCommand
- * \brief starts an if block
- *
- * cmIfCommand starts an if block
- */
+/// Starts an if block
class cmIfCommand : public cmCommand
{
public:
diff --git a/Source/cmMacroCommand.h b/Source/cmMacroCommand.h
index 93e10b2..03aa72d 100644
--- a/Source/cmMacroCommand.h
+++ b/Source/cmMacroCommand.h
@@ -15,11 +15,6 @@
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
-/** \class cmMacroFunctionBlocker
- * \brief subclass of function blocker
- *
- *
- */
class cmMacroFunctionBlocker : public cmFunctionBlocker
{
public:
@@ -35,11 +30,7 @@ public:
int Depth;
};
-/** \class cmMacroCommand
- * \brief starts an if block
- *
- * cmMacroCommand starts an if block
- */
+/// Starts macro() ... endmacro() block
class cmMacroCommand : public cmCommand
{
public:
diff --git a/Source/cmWhileCommand.h b/Source/cmWhileCommand.h
index 04649a3..1947fcf 100644
--- a/Source/cmWhileCommand.h
+++ b/Source/cmWhileCommand.h
@@ -16,11 +16,6 @@
#include "cmFunctionBlocker.h"
#include "cmListFileCache.h"
-/** \class cmWhileFunctionBlocker
- * \brief subclass of function blocker
- *
- *
- */
class cmWhileFunctionBlocker : public cmFunctionBlocker
{
public:
@@ -37,11 +32,7 @@ private:
int Depth;
};
-/** \class cmWhileCommand
- * \brief starts a while loop
- *
- * cmWhileCommand starts a while loop
- */
+/// \brief Starts a while loop
class cmWhileCommand : public cmCommand
{
public: