From 2ab7d2eafc5d5d9061514a9f921fe30861fb5144 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thorbj=C3=B8rn=20Lindeijer?= Date: Fri, 16 Apr 2010 11:46:47 +0200 Subject: Some documentation comment formatting and a rename Renamed RunConfiguration::configurationWidget to createConfigurationWidget. Reviewed-by: dt --- .../applicationrunconfiguration.cpp | 2 +- .../projectexplorer/applicationrunconfiguration.h | 2 +- .../customexecutablerunconfiguration.cpp | 4 +- .../customexecutablerunconfiguration.h | 2 +- src/plugins/projectexplorer/runconfiguration.h | 46 +++++++++++++--------- .../projectexplorer/runsettingspropertiespage.cpp | 8 ++-- 6 files changed, 36 insertions(+), 28 deletions(-) (limited to 'src/plugins/projectexplorer') diff --git a/src/plugins/projectexplorer/applicationrunconfiguration.cpp b/src/plugins/projectexplorer/applicationrunconfiguration.cpp index 750377a4d8..8b2b8e0ef7 100644 --- a/src/plugins/projectexplorer/applicationrunconfiguration.cpp +++ b/src/plugins/projectexplorer/applicationrunconfiguration.cpp @@ -83,7 +83,7 @@ RunControl *LocalApplicationRunControlFactory::create(ProjectExplorer::RunConfig return new LocalApplicationRunControl(qobject_cast(runConfiguration)); } -QWidget *LocalApplicationRunControlFactory::configurationWidget(RunConfiguration *runConfiguration) +QWidget *LocalApplicationRunControlFactory::createConfigurationWidget(RunConfiguration *runConfiguration) { Q_UNUSED(runConfiguration) return new QLabel("TODO add Configuration widget"); diff --git a/src/plugins/projectexplorer/applicationrunconfiguration.h b/src/plugins/projectexplorer/applicationrunconfiguration.h index 08261afa44..22bead2395 100644 --- a/src/plugins/projectexplorer/applicationrunconfiguration.h +++ b/src/plugins/projectexplorer/applicationrunconfiguration.h @@ -74,7 +74,7 @@ public: virtual bool canRun(RunConfiguration *runConfiguration, const QString &mode) const; virtual QString displayName() const; virtual RunControl* create(RunConfiguration *runConfiguration, const QString &mode); - virtual QWidget *configurationWidget(RunConfiguration *runConfiguration); + virtual QWidget *createConfigurationWidget(RunConfiguration *runConfiguration); }; class LocalApplicationRunControl : public RunControl diff --git a/src/plugins/projectexplorer/customexecutablerunconfiguration.cpp b/src/plugins/projectexplorer/customexecutablerunconfiguration.cpp index e087914cf3..de2894ac8c 100644 --- a/src/plugins/projectexplorer/customexecutablerunconfiguration.cpp +++ b/src/plugins/projectexplorer/customexecutablerunconfiguration.cpp @@ -339,7 +339,7 @@ QString CustomExecutableRunConfiguration::executable() const if (m_executable.isEmpty() || !QFileInfo(exec).exists()) { // Oh the executable doesn't exists, ask the user. - QWidget *confWidget = const_cast(this)->configurationWidget(); + QWidget *confWidget = const_cast(this)->createConfigurationWidget(); confWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Fixed); QDialog dialog(Core::ICore::instance()->mainWindow()); dialog.setLayout(new QVBoxLayout()); @@ -514,7 +514,7 @@ void CustomExecutableRunConfiguration::setRunMode(RunMode runMode) emit changed(); } -QWidget *CustomExecutableRunConfiguration::configurationWidget() +QWidget *CustomExecutableRunConfiguration::createConfigurationWidget() { return new CustomExecutableConfigurationWidget(this); } diff --git a/src/plugins/projectexplorer/customexecutablerunconfiguration.h b/src/plugins/projectexplorer/customexecutablerunconfiguration.h index c591a1e9ea..a766529d8a 100644 --- a/src/plugins/projectexplorer/customexecutablerunconfiguration.h +++ b/src/plugins/projectexplorer/customexecutablerunconfiguration.h @@ -98,7 +98,7 @@ public: QStringList commandLineArguments() const; Environment environment() const; - QWidget *configurationWidget(); + QWidget *createConfigurationWidget(); QString dumperLibrary() const; QStringList dumperLibraryLocations() const; diff --git a/src/plugins/projectexplorer/runconfiguration.h b/src/plugins/projectexplorer/runconfiguration.h index 76b9c612a2..e3b03e59b7 100644 --- a/src/plugins/projectexplorer/runconfiguration.h +++ b/src/plugins/projectexplorer/runconfiguration.h @@ -48,7 +48,8 @@ class Target; class RunControl; class BuildConfiguration; -/* Base class for a run configuration. A run configuration specifies how a +/** + * Base class for a run configuration. A run configuration specifies how a * target should be run, while the runner (see below) does the actual running. * * Note that all RunControls and the target hold a shared pointer to the RunConfiguration. @@ -65,17 +66,21 @@ class PROJECTEXPLORER_EXPORT RunConfiguration : public ProjectConfiguration public: virtual ~RunConfiguration(); - // Used to find out whether a runconfiguration works with the given - // buildconfiguration. - // Note: bc may be 0! + /** + * Used to find out whether a runconfiguration works with the given + * buildconfiguration. + * \note bc may be 0! + */ virtual bool isEnabled(BuildConfiguration *bc) const; - // Used to find out whether a runconfiguration works with the active - // buildconfiguration. + + /** + * Used to find out whether a runconfiguration works with the active + * buildconfiguration. + */ bool isEnabled() const; - // Returns the widget used to configure this run configuration. Ownership is transferred to the caller - // rename to createConfigurationWidget - virtual QWidget *configurationWidget() = 0; + /// Returns the widget used to configure this run configuration. Ownership is transferred to the caller + virtual QWidget *createConfigurationWidget() = 0; Target *target() const; @@ -86,14 +91,15 @@ protected: RunConfiguration(Target *parent, const QString &id); RunConfiguration(Target *parent, RunConfiguration *source); - // convenience method to get current build configuration. + /// convenience method to get current build configuration. BuildConfiguration *activeBuildConfiguration() const; private: Target *m_target; }; -/* The run configuration factory is used for restoring run configurations from +/** + * The run configuration factory is used for restoring run configurations from * settings. And used to create new runconfigurations in the "Run Settings" Dialog. * For the first case bool canRestore(Target *parent, const QString &id) and * RunConfiguration* create(Target *parent, const QString &id) are used. @@ -101,8 +107,7 @@ private: * QString displayNameForType(const QString&) are used to generate a list of creatable * RunConfigurations, and create(..) is used to create it. */ -class PROJECTEXPLORER_EXPORT IRunConfigurationFactory : - public QObject +class PROJECTEXPLORER_EXPORT IRunConfigurationFactory : public QObject { Q_OBJECT @@ -110,9 +115,10 @@ public: explicit IRunConfigurationFactory(QObject *parent = 0); virtual ~IRunConfigurationFactory(); - // used to show the list of possible additons to a target, returns a list of types + /// used to show the list of possible additons to a target, returns a list of types virtual QStringList availableCreationIds(Target *parent) const = 0; - // used to translate the types to names to display to the user + + /// used to translate the types to names to display to the user virtual QString displayNameForId(const QString &id) const = 0; virtual bool canCreate(Target *parent, const QString &id) const = 0; @@ -142,13 +148,15 @@ public: virtual QString displayName() const = 0; - // Returns the widget used to configure this runner. Ownership is transferred to the caller - virtual QWidget *configurationWidget(RunConfiguration *runConfiguration) = 0; + /// Returns the widget used to configure this runner. Ownership is transferred to the caller + virtual QWidget *createConfigurationWidget(RunConfiguration *runConfiguration) = 0; }; -/* Each instance of this class represents one item that is run. +/** + * Each instance of this class represents one item that is run. */ -class PROJECTEXPLORER_EXPORT RunControl : public QObject { +class PROJECTEXPLORER_EXPORT RunControl : public QObject +{ Q_OBJECT public: explicit RunControl(RunConfiguration *runConfiguration); diff --git a/src/plugins/projectexplorer/runsettingspropertiespage.cpp b/src/plugins/projectexplorer/runsettingspropertiespage.cpp index 0956b3d153..1c56ccbdd8 100644 --- a/src/plugins/projectexplorer/runsettingspropertiespage.cpp +++ b/src/plugins/projectexplorer/runsettingspropertiespage.cpp @@ -237,7 +237,7 @@ RunSettingsWidget::RunSettingsWidget(Target *target) m_ui->removeToolButton->setEnabled(m_target->runConfigurations().size() > 1); - m_runConfigurationWidget = m_target->activeRunConfiguration()->configurationWidget(); + m_runConfigurationWidget = m_target->activeRunConfiguration()->createConfigurationWidget(); layout()->addWidget(m_runConfigurationWidget); connect(m_addMenu, SIGNAL(aboutToShow()), @@ -255,7 +255,7 @@ RunSettingsWidget::RunSettingsWidget(Target *target) QList runners = PluginManager::instance()->getObjects(); foreach (IRunControlFactory * runner, runners) { if (runner->canRun(activeRunConfiguration)) - m_ui->layout->addWidget(runner->configurationWidget(activeRunConfiguration)); + m_ui->layout->addWidget(runner->createConfigurationWidget(activeRunConfiguration)); } */ } @@ -317,7 +317,7 @@ void RunSettingsWidget::activeRunConfigurationChanged() m_ignoreChange = false; delete m_runConfigurationWidget; - m_runConfigurationWidget = m_target->activeRunConfiguration()->configurationWidget(); + m_runConfigurationWidget = m_target->activeRunConfiguration()->createConfigurationWidget(); layout()->addWidget(m_runConfigurationWidget); } @@ -339,6 +339,6 @@ void RunSettingsWidget::currentRunConfigurationChanged(int index) // Update the run configuration configuration widget delete m_runConfigurationWidget; - m_runConfigurationWidget = selectedRunConfiguration->configurationWidget(); + m_runConfigurationWidget = selectedRunConfiguration->createConfigurationWidget(); layout()->addWidget(m_runConfigurationWidget); } -- cgit v1.2.1