Doxygen and license headers

qgis · Apr 9, 2018 · 3a5e96a · 3a5e96a
1 parent 147f6e7
commit 3a5e96a
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 0 deletions.
diff --git a/src/core/processing/qgsprocessingalgorithmconfigurationwidget.cpp b/src/core/processing/qgsprocessingalgorithmconfigurationwidget.cpp
@@ -1,3 +1,20 @@
+/***************************************************************************
+                         qgsprocessingalgorithmconfig.cpp
+                         --------------------------
+    begin                : April 2018
+    copyright            : (C) 2018 by Matthias Kuhn
+    email                : matthias@opengis.ch
+ ***************************************************************************/
+
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
 #include "qgsprocessingalgorithmconfigurationwidget.h"
 
 QgsProcessingAlgorithmConfigurationWidget::QgsProcessingAlgorithmConfigurationWidget( QWidget *parent )

diff --git a/src/core/processing/qgsprocessingalgorithmconfigurationwidget.h b/src/core/processing/qgsprocessingalgorithmconfigurationwidget.h
@@ -1,3 +1,21 @@
+/***************************************************************************
+                         qgsprocessingalgorithmconfig.h
+                         --------------------------
+    begin                : April 2018
+    copyright            : (C) 2018 by Matthias Kuhn
+    email                : matthias@opengis.ch
+ ***************************************************************************/
+
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+
 #ifndef QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
 #define QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
 
@@ -7,14 +25,32 @@
 
 #include "qgis_core.h"
 
+/**
+ * A configuration widget for processing algorithms allows to provide additional
+ * configuration options directly on algorithm level, in addition to parameters.
+ *
+ * \since QGIS 3.2
+ * \ingroup core
+ */
 class CORE_EXPORT QgsProcessingAlgorithmConfigurationWidget : public QWidget
 {
     Q_OBJECT
 
   public:
+    /**
+     * Creates a new QgsProcessingAlgorithmConfigurationWidget
+     */
     QgsProcessingAlgorithmConfigurationWidget( QWidget *parent = nullptr );
     virtual ~QgsProcessingAlgorithmConfigurationWidget() = default;
+
+    /**
+     * Read the current configuration from this widget.
+     */
     virtual QVariantMap configuration() const = 0;
+
+    /**
+     * Set the configuration which this widget should represent.
+     */
     virtual void setConfiguration( const QVariantMap &configuration ) = 0;
 };