From 2cf14efabdaacf233755cb39a26acc3dafd6bb1f Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@digia.com>
Date: Mon, 9 Sep 2013 15:38:35 +0200
Subject: [PATCH] Doc: move documentation from header to source
QDoc does not look for documentation in header files.
Change-Id: Ibe20a39320a08e936cc4ede25678197c0cee2f4f
Reviewed-by: Daniel Teske <daniel.teske@digia.com>
---
.../publishing/ipublishingwizardfactory.cpp | 78 +++++++++++++++++++
.../publishing/ipublishingwizardfactory.h | 36 +--------
2 files changed, 79 insertions(+), 35 deletions(-)
create mode 100644 src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp
diff --git a/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp
new file mode 100644
index 0000000000..87a4fd5beb
--- /dev/null
+++ b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.cpp
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** 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 <ipublishingwizardfactory.h>
+
+
+/*!
+ \class ProjectExplorer::IPublishingWizardFactory
+
+ \brief The IPublishingWizardFactory class provides an interface for creating
+ wizards to publish a project.
+
+ A class implementing this interface is used to create an associated wizard
+ that allows users to publish their project to a remote facility, such as an
+ app store.
+
+ Such a wizard would typically transform the project content into a format
+ expected by that facility (\e packaging) and also upload it, if possible.
+
+ The factory objects have to be added to the global object pool via
+ \c ExtensionSystem::PluginManager::addObject().
+
+ \sa ExtensionSystem::PluginManager::addObject()
+*/
+
+/*!
+ \fn virtual QString displayName() const = 0
+
+ Describes on one line the type of wizard that this factory can create.
+*/
+
+ /*!
+ \fn virtual QString description() const = 0
+
+ Explains the exact purpose of the wizard created by this factory.
+*/
+
+/*!
+ \fn virtual bool canCreateWizard(const Project *project) const = 0
+
+ Returns true if the type of wizard that this factory can create is available
+ for the specified \a project.
+*/
+
+/*!
+ \fn virtual QWizard *createWizard(const Project *project) const = 0
+
+ Creates a wizard that can publish \a project. Behavior is undefined if
+ canCreateWizard() returns \c false for the project. Returns the newly
+ created publishing wizard
+
+ \sa canCreateWizard()
+*/
diff --git a/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h
index 25b35c805f..cf0d62acb9 100644
--- a/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h
+++ b/src/plugins/projectexplorer/publishing/ipublishingwizardfactory.h
@@ -39,52 +39,18 @@
namespace ProjectExplorer {
class Project;
-/*!
- \class ProjectExplorer::IPublishingWizardFactory
-
- \brief Provides an interface for creating wizards to publish a project.
-
- A class implementing this interface is used to create an associated wizard
- that allows users to publish their project to a remote facility, e.g. an
- app store.
- Such a wizard would typically transform the project's content into
- a form expected by that facility ("packaging") and also upload it, if possible.
-
- The factory objects have to be added to the global object pool via
- \c ExtensionSystem::PluginManager::addObject().
- \sa ExtensionSystem::PluginManager::addObject()
-*/
-
class PROJECTEXPLORER_EXPORT IPublishingWizardFactory : public QObject
{
Q_OBJECT
public:
- /*!
- A short, one-line description of the type of wizard that this
- factory can create.
- */
+
virtual QString displayName() const = 0;
- /*!
- A longer description explaining the exact purpose of the wizard
- created by this factory.
- */
virtual QString description() const = 0;
- /*!
- Returns true iff the type of wizard that this factory can create
- is available for the given project.
- */
virtual bool canCreateWizard(const Project *project) const = 0;
- /*!
- Creates a wizard that can publish the given project.
- Behavior is undefined if canCreateWizard() returns false for
- that project.
- \return The newly created publishing wizard
- \sa canCreateWizard()
- */
virtual QWizard *createWizard(const Project *project) const = 0;
protected:
--
GitLab