summaryrefslogtreecommitdiffstats
path: root/Source/cmWindowsConfigure.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmWindowsConfigure.h')
-rw-r--r--Source/cmWindowsConfigure.h27
1 files changed, 18 insertions, 9 deletions
diff --git a/Source/cmWindowsConfigure.h b/Source/cmWindowsConfigure.h
index 8922d97..191ee1d 100644
--- a/Source/cmWindowsConfigure.h
+++ b/Source/cmWindowsConfigure.h
@@ -13,34 +13,43 @@
See COPYRIGHT.txt for copyright details.
=========================================================================*/
-/**
- * cmWindowsConfigure : a class that configures the build
- * on windows where autoconf configure can not be used.
- * The system specific .h files normal generated by autoconf
- * should be generated by sub-classes of this class.
- */
#ifndef cmWindowsConfigure_h
#define cmWindowsConfigure_h
+
#include "cmStandardIncludes.h"
+/** \class cmWindowsConfigure
+ * \brief Configure the build process on Windows systems.
+ *
+ * cmWindowsConfigure configures the build process
+ * on windows where the Unix autoconf configure can not be used.
+ * The system specific .h files normally generated by autoconf
+ * should be generated by sub-classes of this class.
+ */
class cmWindowsConfigure
{
public:
/**
- * Set the path to the top level of the source directory
+ * Set the path to the top level of the source directory.
*/
void SetWhereSource(const char* dir)
{
- m_WhereSource = dir;
+ m_WhereSource = dir;
}
+
/**
- * Set the path to the top level of the build directory
+ * Set the path to the top level of the build directory.
*/
void SetWhereBuild(const char* dir)
{
m_WhereBuild = dir;
}
+
+ /**
+ * Perform the configure process.
+ */
virtual bool Configure(const char* input);
+
protected:
std::string m_WhereSource;
std::string m_WhereBuild;