From 4254e90981816ba39ece2f2c2cd50e12a1fca3cf Mon Sep 17 00:00:00 2001
From: Lars Bilke <lars.bilke@ufz.de>
Date: Tue, 21 Aug 2012 16:24:08 +0200
Subject: [PATCH] Some missing class documentation.
---
Gui/Base/QValueTooltipSlider.h | 3 ++
Gui/Base/StrictDoubleValidator.h | 7 +++--
Gui/Base/StrictIntValidator.h | 7 +++--
Gui/DataView/NetCdfConfigureDialog.h | 5 +++-
Gui/VtkVis/VtkCompositeFilter.h | 42 +++++++++++++++-------------
Gui/VtkVis/VtkGeoImageSource.h | 4 ++-
Gui/VtkVis/VtkSelectionFilter.h | 3 ++
Gui/VtkVis/VtkVisHelper.h | 3 ++
MeshLib/MshEnums.h | 3 ++
9 files changed, 49 insertions(+), 28 deletions(-)
diff --git a/Gui/Base/QValueTooltipSlider.h b/Gui/Base/QValueTooltipSlider.h
index 3facee9475c..c4a62bfe3f7 100644
--- a/Gui/Base/QValueTooltipSlider.h
+++ b/Gui/Base/QValueTooltipSlider.h
@@ -8,6 +8,9 @@
#include <QSlider>
+/**
+ * \brief A QSlider which shows its value as a tooltip when moved.
+ */
class QValueTooltipSlider : public QSlider
{
Q_OBJECT
diff --git a/Gui/Base/StrictDoubleValidator.h b/Gui/Base/StrictDoubleValidator.h
index 1b845ff813c..b1803c1ba04 100644
--- a/Gui/Base/StrictDoubleValidator.h
+++ b/Gui/Base/StrictDoubleValidator.h
@@ -8,11 +8,12 @@
#ifndef STRICTDOUBLEVALIDATOR_H_
#define STRICTDOUBLEVALIDATOR_H_
-// source code adapted from:
-// http://developer.qt.nokia.com/faq/answer/i_can_still_insert_numbers_outside_the_range_specified_with_a_qdoublevalida
-
#include <QDoubleValidator>
+/**
+ * \brief A validator for an input field which only accepts decimals.
+ * Source code adapted from [Qt developer fac](http://developer.qt.nokia.com/faq/answer/i_can_still_insert_numbers_outside_the_range_specified_with_a_qdoublevalida)
+ */
class StrictDoubleValidator : public QDoubleValidator
{
public:
diff --git a/Gui/Base/StrictIntValidator.h b/Gui/Base/StrictIntValidator.h
index ad7533b1ade..90644b38298 100644
--- a/Gui/Base/StrictIntValidator.h
+++ b/Gui/Base/StrictIntValidator.h
@@ -8,11 +8,12 @@
#ifndef STRICTINTVALIDATOR_H_
#define STRICTINTVALIDATOR_H_
-// source code adapted from:
-// http://developer.qt.nokia.com/faq/answer/i_can_still_insert_numbers_outside_the_range_specified_with_a_qdoublevalida
-
#include <QIntValidator>
+/**
+ * \brief A validator for an input field which only accepts integers.
+ * Source code adapted from [Qt developer fac](http://developer.qt.nokia.com/faq/answer/i_can_still_insert_numbers_outside_the_range_specified_with_a_qdoublevalida)
+ */
class StrictIntValidator : public QIntValidator
{
public:
diff --git a/Gui/DataView/NetCdfConfigureDialog.h b/Gui/DataView/NetCdfConfigureDialog.h
index 8c43863bc11..f7a5aed8334 100644
--- a/Gui/DataView/NetCdfConfigureDialog.h
+++ b/Gui/DataView/NetCdfConfigureDialog.h
@@ -18,6 +18,9 @@ namespace MeshLib {
class VtkGeoImageSource;
+/**
+ * \brief The dialog which presents the user options to load NetCDF-files.
+ */
class NetCdfConfigureDialog : public QDialog, private Ui_NetCdfConfigure
{
Q_OBJECT
@@ -52,7 +55,7 @@ private:
double getResolution();
QString setName();
void reverseNorthSouth(double* data, size_t width, size_t height);
-
+
NcFile *_currentFile;
NcVar *_currentVar;
QDateTime _currentInitialDateTime;
diff --git a/Gui/VtkVis/VtkCompositeFilter.h b/Gui/VtkVis/VtkCompositeFilter.h
index a83e098b167..992eb21eb8f 100644
--- a/Gui/VtkVis/VtkCompositeFilter.h
+++ b/Gui/VtkVis/VtkCompositeFilter.h
@@ -10,25 +10,26 @@
class vtkAlgorithm;
-/// @brief Is used to combine several filter in one VtkVisPipelineItem. You can
-/// use vtk filter and custom filter. To subclass this you have to implement the
-/// init() function. There you combine the filters. Make sure to set the members
-/// _inputDataObjectType, _outputDataObjectType and _outputAlgorithm. Make also
-/// sure to implement VtkAlgorithmProperties::SetUserProperty() and
-/// VtkAlgorithmProperties::SetUserVectorProperty().
-///
-/// Allocate vtk objects inside init() with vtkSmartPointer except for the last
-/// filter. This filter must also be set to _outputAlgorithm, e.g.
-/// \code
-/// MyVtkFilter* lastFilter = MyVtkFilter::New();
-/// ...(do something here)
-/// _outputAlgorithm = lastFilter;
-/// \endcode
-///
-/// Create user properties with ogsUserPropertyMacro or ogsUserVecxPropertyMacro
-/// and initialize these properties inside the constructor with
-/// this->Set[Property Name](value)
-/// See VtkCompositeThresholdFilter for an example.
+/**
+ * @brief Is used to combine several filter in one VtkVisPipelineItem. You can
+ * use vtk filter and custom filter. To subclass this you have to implement the
+ * init() function. There you combine the filters. Make sure to set the members
+ * _inputDataObjectType, _outputDataObjectType and _outputAlgorithm. Make also
+ * sure to implement VtkAlgorithmProperties::SetUserProperty() and
+ * VtkAlgorithmProperties::SetUserVectorProperty().
+ *
+ * Allocate vtk objects inside init() with vtkSmartPointer except for the last
+ * filter. This filter must also be set to _outputAlgorithm, e.g.
+ *
+ * MyVtkFilter* lastFilter = MyVtkFilter::New();
+ * ...(do something here)
+ * _outputAlgorithm = lastFilter;
+ *
+ * Create user properties with `ogsUserPropertyMacro` or `ogsUserVecxPropertyMacro`
+ * and initialize these properties inside the constructor with
+ * `this->Set[Property Name](value)`.
+ * See VtkCompositeThresholdFilter for an example.
+ */
class VtkCompositeFilter : public VtkAlgorithmProperties
{
public:
@@ -57,7 +58,8 @@ public:
vtkAlgorithm* GetOutputAlgorithm() const { return _outputAlgorithm; }
protected:
- /// See vtkSetGet.h for the defines
+ /// See [vtkSetGet.h](https://github.com/Kitware/VTK/blob/master/Common/Core/vtkSetGet.h)
+ /// for the defines
int _inputDataObjectType;
int _outputDataObjectType;
diff --git a/Gui/VtkVis/VtkGeoImageSource.h b/Gui/VtkVis/VtkGeoImageSource.h
index 3e12f7ab926..b24877a23f5 100644
--- a/Gui/VtkVis/VtkGeoImageSource.h
+++ b/Gui/VtkVis/VtkGeoImageSource.h
@@ -16,7 +16,9 @@ class vtkQImageToImageSource;
class vtkImageShiftScale;
class vtkImageData;
-
+/**
+ * \brief The VtkVisPipeline source object of a geo-referenced image (file).
+ */
class VtkGeoImageSource : public vtkSimpleImageToImageFilter, public VtkAlgorithmProperties
{
public:
diff --git a/Gui/VtkVis/VtkSelectionFilter.h b/Gui/VtkVis/VtkSelectionFilter.h
index c58e6f6ee65..86843bda388 100644
--- a/Gui/VtkVis/VtkSelectionFilter.h
+++ b/Gui/VtkVis/VtkSelectionFilter.h
@@ -14,6 +14,9 @@
#include <vector>
+/**
+ * \brief
+ */
class VtkSelectionFilter : public vtkUnstructuredGridAlgorithm, public VtkAlgorithmProperties
{
public:
diff --git a/Gui/VtkVis/VtkVisHelper.h b/Gui/VtkVis/VtkVisHelper.h
index 088bd54aa46..26c1cf478ee 100644
--- a/Gui/VtkVis/VtkVisHelper.h
+++ b/Gui/VtkVis/VtkVisHelper.h
@@ -10,6 +10,9 @@ class QImage;
class vtkTexture;
class vtkImageData;
+/**
+ * \brief Some data conversion helper functions.
+ */
class VtkVisHelper
{
public:
diff --git a/MeshLib/MshEnums.h b/MeshLib/MshEnums.h
index 765a4dcfd9c..baf5465baec 100644
--- a/MeshLib/MshEnums.h
+++ b/MeshLib/MshEnums.h
@@ -32,6 +32,9 @@ struct MshElemType
};
};
+/**
+ * \brief Describes a mesh quality criteria.
+ */
struct MshQualityType
{
enum type {
--
GitLab