From 0d5c899091504fc8dfd2e34db8abb85204582708 Mon Sep 17 00:00:00 2001
From: Mikhail Svechnikov <m.svechnikov@fz-juelich.de>
Date: Thu, 22 Dec 2022 12:00:19 +0100
Subject: [PATCH] unify method descriptions in catalogs
---
GUI/Model/CatDevice/BackgroundItemCatalog.h | 5 +----
GUI/Model/CatDevice/DetectorItemCatalog.h | 4 +---
GUI/Model/CatDevice/DistributionItemCatalog.h | 9 +--------
GUI/Model/CatDevice/FootprintItemCatalog.h | 5 +----
GUI/Model/CatDevice/InstrumentItemCatalog.h | 2 +-
GUI/Model/CatDevice/MaskItemCatalog.h | 2 +-
GUI/Model/CatDevice/ResolutionFunctionItemCatalog.h | 4 +---
GUI/Model/CatSample/FormFactorItemCatalog.h | 8 +-------
GUI/Model/CatSample/InterferenceItemCatalog.h | 7 +------
GUI/Model/CatSample/ItemWithParticlesCatalog.h | 5 +----
GUI/Model/CatSample/RotationItemCatalog.h | 7 +------
GUI/Model/CatSample/RoughnessItemCatalog.h | 7 +------
12 files changed, 12 insertions(+), 53 deletions(-)
diff --git a/GUI/Model/CatDevice/BackgroundItemCatalog.h b/GUI/Model/CatDevice/BackgroundItemCatalog.h
index 6e4d54d95d3..4a7e3cd92c9 100644
--- a/GUI/Model/CatDevice/BackgroundItemCatalog.h
+++ b/GUI/Model/CatDevice/BackgroundItemCatalog.h
@@ -35,10 +35,7 @@ public:
//! Creates the item of the given type.
static BackgroundItem* create(Type type);
- //! Available types of items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatDevice/DetectorItemCatalog.h b/GUI/Model/CatDevice/DetectorItemCatalog.h
index 6d114b3e84c..012e29d4bd0 100644
--- a/GUI/Model/CatDevice/DetectorItemCatalog.h
+++ b/GUI/Model/CatDevice/DetectorItemCatalog.h
@@ -35,9 +35,7 @@ public:
//! Creates the item of the given type.
static DetectorItem* create(Type type);
- //! Available types of items.
- //!
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatDevice/DistributionItemCatalog.h b/GUI/Model/CatDevice/DistributionItemCatalog.h
index 587d439baba..e685977d356 100644
--- a/GUI/Model/CatDevice/DistributionItemCatalog.h
+++ b/GUI/Model/CatDevice/DistributionItemCatalog.h
@@ -44,16 +44,9 @@ public:
//! Creates the item of the given type.
static DistributionItem* create(Type type);
- //! Available types of items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
- //! Types of symmetric distributions
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
static QVector<Type> symmetricTypes();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatDevice/FootprintItemCatalog.h b/GUI/Model/CatDevice/FootprintItemCatalog.h
index cb253eabb12..4e426100b26 100644
--- a/GUI/Model/CatDevice/FootprintItemCatalog.h
+++ b/GUI/Model/CatDevice/FootprintItemCatalog.h
@@ -35,10 +35,7 @@ public:
//! Creates the item of the given type.
static FootprintItem* create(Type type);
- //! Available types of items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatDevice/InstrumentItemCatalog.h b/GUI/Model/CatDevice/InstrumentItemCatalog.h
index d7410893ccf..5ed3fe26a5c 100644
--- a/GUI/Model/CatDevice/InstrumentItemCatalog.h
+++ b/GUI/Model/CatDevice/InstrumentItemCatalog.h
@@ -35,7 +35,7 @@ public:
//! Creates the item of the given type.
static InstrumentItem* create(Type type);
- //! Available types of items.
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatDevice/MaskItemCatalog.h b/GUI/Model/CatDevice/MaskItemCatalog.h
index 13dda1ad72e..7192681b018 100644
--- a/GUI/Model/CatDevice/MaskItemCatalog.h
+++ b/GUI/Model/CatDevice/MaskItemCatalog.h
@@ -43,7 +43,7 @@ public:
//! Creates the item of the given type.
static MaskItem* create(Type type);
- //! Available types of items.
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatDevice/ResolutionFunctionItemCatalog.h b/GUI/Model/CatDevice/ResolutionFunctionItemCatalog.h
index e36eb22f9fb..b0d4e0bf800 100644
--- a/GUI/Model/CatDevice/ResolutionFunctionItemCatalog.h
+++ b/GUI/Model/CatDevice/ResolutionFunctionItemCatalog.h
@@ -38,9 +38,7 @@ public:
static ResolutionFunctionItem* create(Type type,
const std::variant<QString, Unit>& unit = Unit::unitless);
- //! Available types of items.
- //!
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatSample/FormFactorItemCatalog.h b/GUI/Model/CatSample/FormFactorItemCatalog.h
index 23f63fb95d8..2e5f45e72a6 100644
--- a/GUI/Model/CatSample/FormFactorItemCatalog.h
+++ b/GUI/Model/CatSample/FormFactorItemCatalog.h
@@ -67,20 +67,14 @@ public:
//! Creates the item of the given type.
- //!
- //! If type is "None", a nullptr is returned.
static FormFactorItem* create(Type type);
- //! Available types of interference items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
static QVector<Type> hardParticleTypes();
static QVector<Type> rippleTypes();
-
//! UiInfo on the given type.
static UiInfo uiInfo(Type t);
diff --git a/GUI/Model/CatSample/InterferenceItemCatalog.h b/GUI/Model/CatSample/InterferenceItemCatalog.h
index faa552cf81d..ff1eee9a65b 100644
--- a/GUI/Model/CatSample/InterferenceItemCatalog.h
+++ b/GUI/Model/CatSample/InterferenceItemCatalog.h
@@ -43,14 +43,9 @@ public:
//! Creates the item of the given type.
- //!
- //! If type is "None", a nullptr is returned.
static InterferenceItem* create(Type type);
- //! Available types of interference items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatSample/ItemWithParticlesCatalog.h b/GUI/Model/CatSample/ItemWithParticlesCatalog.h
index ee86c51d28d..798a191925d 100644
--- a/GUI/Model/CatSample/ItemWithParticlesCatalog.h
+++ b/GUI/Model/CatSample/ItemWithParticlesCatalog.h
@@ -35,14 +35,11 @@ public:
};
//! Creates the item of the given type.
- //!
- //! If type is "None", a nullptr is returned.
static ItemWithParticles* create(Type type, const MaterialModel* materials);
- //! Available types of items, sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
- //! Available types of assembly items, sorted as expected in the UI (e.g. in combo box)
static QVector<Type> assemblyTypes();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatSample/RotationItemCatalog.h b/GUI/Model/CatSample/RotationItemCatalog.h
index 4b7030809b9..57e12c7705c 100644
--- a/GUI/Model/CatSample/RotationItemCatalog.h
+++ b/GUI/Model/CatSample/RotationItemCatalog.h
@@ -40,14 +40,9 @@ public:
};
//! Creates the item of the given type.
- //!
- //! If type is "None", a nullptr is returned.
static RotationItem* create(Type type);
- //! Available types of interference items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
diff --git a/GUI/Model/CatSample/RoughnessItemCatalog.h b/GUI/Model/CatSample/RoughnessItemCatalog.h
index f50ac649d39..92f8076a52b 100644
--- a/GUI/Model/CatSample/RoughnessItemCatalog.h
+++ b/GUI/Model/CatSample/RoughnessItemCatalog.h
@@ -34,14 +34,9 @@ public:
};
//! Creates the item of the given type.
- //!
- //! If type is "None", a nullptr is returned.
static RoughnessItem* create(Type type);
- //! Available types of interference items.
- //!
- //! Contains also type "None".
- //! This list is sorted as expected in the UI (e.g. in combo box)
+ //! List of available types, sorted as expected in the UI.
static QVector<Type> types();
//! UiInfo on the given type.
--
GitLab