Skip to content
Snippets Groups Projects
Commit 4254e909 authored by Lars Bilke's avatar Lars Bilke
Browse files

Some missing class documentation.

parent 38071fd8
No related branches found
No related tags found
No related merge requests found
...@@ -8,6 +8,9 @@ ...@@ -8,6 +8,9 @@
#include <QSlider> #include <QSlider>
/**
* \brief A QSlider which shows its value as a tooltip when moved.
*/
class QValueTooltipSlider : public QSlider class QValueTooltipSlider : public QSlider
{ {
Q_OBJECT Q_OBJECT
......
...@@ -8,11 +8,12 @@ ...@@ -8,11 +8,12 @@
#ifndef STRICTDOUBLEVALIDATOR_H_ #ifndef STRICTDOUBLEVALIDATOR_H_
#define 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> #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 class StrictDoubleValidator : public QDoubleValidator
{ {
public: public:
......
...@@ -8,11 +8,12 @@ ...@@ -8,11 +8,12 @@
#ifndef STRICTINTVALIDATOR_H_ #ifndef STRICTINTVALIDATOR_H_
#define 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> #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 class StrictIntValidator : public QIntValidator
{ {
public: public:
......
...@@ -18,6 +18,9 @@ namespace MeshLib { ...@@ -18,6 +18,9 @@ namespace MeshLib {
class VtkGeoImageSource; class VtkGeoImageSource;
/**
* \brief The dialog which presents the user options to load NetCDF-files.
*/
class NetCdfConfigureDialog : public QDialog, private Ui_NetCdfConfigure class NetCdfConfigureDialog : public QDialog, private Ui_NetCdfConfigure
{ {
Q_OBJECT Q_OBJECT
...@@ -52,7 +55,7 @@ private: ...@@ -52,7 +55,7 @@ private:
double getResolution(); double getResolution();
QString setName(); QString setName();
void reverseNorthSouth(double* data, size_t width, size_t height); void reverseNorthSouth(double* data, size_t width, size_t height);
NcFile *_currentFile; NcFile *_currentFile;
NcVar *_currentVar; NcVar *_currentVar;
QDateTime _currentInitialDateTime; QDateTime _currentInitialDateTime;
......
...@@ -10,25 +10,26 @@ ...@@ -10,25 +10,26 @@
class vtkAlgorithm; 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 * @brief Is used to combine several filter in one VtkVisPipelineItem. You can
/// init() function. There you combine the filters. Make sure to set the members * use vtk filter and custom filter. To subclass this you have to implement the
/// _inputDataObjectType, _outputDataObjectType and _outputAlgorithm. Make also * init() function. There you combine the filters. Make sure to set the members
/// sure to implement VtkAlgorithmProperties::SetUserProperty() and * _inputDataObjectType, _outputDataObjectType and _outputAlgorithm. Make also
/// VtkAlgorithmProperties::SetUserVectorProperty(). * 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. * Allocate vtk objects inside init() with vtkSmartPointer except for the last
/// \code * filter. This filter must also be set to _outputAlgorithm, e.g.
/// MyVtkFilter* lastFilter = MyVtkFilter::New(); *
/// ...(do something here) * MyVtkFilter* lastFilter = MyVtkFilter::New();
/// _outputAlgorithm = lastFilter; * ...(do something here)
/// \endcode * _outputAlgorithm = lastFilter;
/// *
/// Create user properties with ogsUserPropertyMacro or ogsUserVecxPropertyMacro * Create user properties with `ogsUserPropertyMacro` or `ogsUserVecxPropertyMacro`
/// and initialize these properties inside the constructor with * and initialize these properties inside the constructor with
/// this->Set[Property Name](value) * `this->Set[Property Name](value)`.
/// See VtkCompositeThresholdFilter for an example. * See VtkCompositeThresholdFilter for an example.
*/
class VtkCompositeFilter : public VtkAlgorithmProperties class VtkCompositeFilter : public VtkAlgorithmProperties
{ {
public: public:
...@@ -57,7 +58,8 @@ public: ...@@ -57,7 +58,8 @@ public:
vtkAlgorithm* GetOutputAlgorithm() const { return _outputAlgorithm; } vtkAlgorithm* GetOutputAlgorithm() const { return _outputAlgorithm; }
protected: 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 _inputDataObjectType;
int _outputDataObjectType; int _outputDataObjectType;
......
...@@ -16,7 +16,9 @@ class vtkQImageToImageSource; ...@@ -16,7 +16,9 @@ class vtkQImageToImageSource;
class vtkImageShiftScale; class vtkImageShiftScale;
class vtkImageData; class vtkImageData;
/**
* \brief The VtkVisPipeline source object of a geo-referenced image (file).
*/
class VtkGeoImageSource : public vtkSimpleImageToImageFilter, public VtkAlgorithmProperties class VtkGeoImageSource : public vtkSimpleImageToImageFilter, public VtkAlgorithmProperties
{ {
public: public:
......
...@@ -14,6 +14,9 @@ ...@@ -14,6 +14,9 @@
#include <vector> #include <vector>
/**
* \brief
*/
class VtkSelectionFilter : public vtkUnstructuredGridAlgorithm, public VtkAlgorithmProperties class VtkSelectionFilter : public vtkUnstructuredGridAlgorithm, public VtkAlgorithmProperties
{ {
public: public:
......
...@@ -10,6 +10,9 @@ class QImage; ...@@ -10,6 +10,9 @@ class QImage;
class vtkTexture; class vtkTexture;
class vtkImageData; class vtkImageData;
/**
* \brief Some data conversion helper functions.
*/
class VtkVisHelper class VtkVisHelper
{ {
public: public:
......
...@@ -32,6 +32,9 @@ struct MshElemType ...@@ -32,6 +32,9 @@ struct MshElemType
}; };
}; };
/**
* \brief Describes a mesh quality criteria.
*/
struct MshQualityType struct MshQualityType
{ {
enum type { enum type {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment