diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-09 15:52:19 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-10 17:05:54 +0200 |
commit | 8b9b977f0fc3259efd86cb96173081bf988422ba (patch) | |
tree | 70eb5695aff016746008756343a0a7c4c00f25ce | |
parent | 4f07bd688a1fdbccb3598d3e894b2c876dbb9c0f (diff) | |
download | qt-creator-8b9b977f0fc3259efd86cb96173081bf988422ba.tar.gz |
Doc: move documentation from header to source file
QDoc does not look for documentation in header files.
Change-Id: Id7f6a44112e2385989b62a9dd2ee3a18e0c0ff7b
Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
-rw-r--r-- | src/plugins/projectexplorer/devicesupport/idevicewidget.cpp | 51 | ||||
-rw-r--r-- | src/plugins/projectexplorer/devicesupport/idevicewidget.h | 19 |
2 files changed, 51 insertions, 19 deletions
diff --git a/src/plugins/projectexplorer/devicesupport/idevicewidget.cpp b/src/plugins/projectexplorer/devicesupport/idevicewidget.cpp new file mode 100644 index 0000000000..c7b0be4ee4 --- /dev/null +++ b/src/plugins/projectexplorer/devicesupport/idevicewidget.cpp @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ +#include <idevicewidget.h> + +/*! + \class ProjectExplorer::IDeviceWidget + \brief The IDeviceWidget class provides an interface for the widget + configuring an IDevice. + + A class implementing this interface will display a widget on the + \gui Devices options page. It enables the user to configure a particular + device. +*/ + +/*! + \fn virtual void updateDeviceFromUi() + + Ensures that all changes in the UI are propagated to the device object. + + If the device is always updated right when the change happens, the + implementation of this function can be empty. However, you cannot generally + rely on the QLineEdit::editingFinished() signal being emitted on time if + some button in the dialog is clicked (such as \gui Apply). So if you have + any handlers for line edit changes, they should probably be called here. +*/ diff --git a/src/plugins/projectexplorer/devicesupport/idevicewidget.h b/src/plugins/projectexplorer/devicesupport/idevicewidget.h index 19fb750954..9c728ddd51 100644 --- a/src/plugins/projectexplorer/devicesupport/idevicewidget.h +++ b/src/plugins/projectexplorer/devicesupport/idevicewidget.h @@ -36,30 +36,11 @@ namespace ProjectExplorer { -/*! - \class ProjectExplorer::IDeviceWidget - - \brief Provides an interface for the widget configuring an IDevice. - - A class implementing this interface will display a widget in the configuration - options page "Devices". - It is used to let the user configure a particular device. -*/ - class PROJECTEXPLORER_EXPORT IDeviceWidget : public QWidget { Q_OBJECT public: - /*! - * \brief Ensures that all changes in the UI are propagated to the device object. - * - * If the device is always updated right when the change happens, the implementation of - * this function can be empty. Note, however, that you cannot generally rely on the - * QLineEdit::editingFinished() signal being emitted on time if some button in the dialog is - * clicked (e.g. "Apply"). So if you have any handlers for line edit changes, they should - * probably be called here. - */ virtual void updateDeviceFromUi() = 0; protected: |