From 843932c16b0020ea62ed5b4c7b60e3f81f1d275d Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Wed, 16 Nov 2022 10:39:30 +0100
Subject: [PATCH] Doxy comments more concise
---
Device/Detector/IDetector.h | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/Device/Detector/IDetector.h b/Device/Detector/IDetector.h
index f7a233a758b..ca7e1dcef7d 100644
--- a/Device/Detector/IDetector.h
+++ b/Device/Detector/IDetector.h
@@ -211,19 +211,17 @@ protected:
//! Returns the name for the axis with given index
virtual std::string axisName(size_t index) const = 0;
- //! Return 0 if no ROI has been explicitly set.
- //! Size means number of data points.
+ //! Return number of data points in Roi, or 0 if no Roi is set.
virtual size_t sizeOfExplicitRegionOfInterest() const;
- //! Lower and upper bound of one axis of an explicitly set ROI.
- //! Return 0/0 if no ROI has been explicitly set.
+ //! Returns lower and upper Roi bound of one axis, or (0,0) if no Roi is set.
virtual std::pair<double, double> boundsOfExplicitRegionOfInterest(size_t iAxis) const;
- //! Calculate global index from two axis indices
+ //! Returns flattened index computed from two axis indices.
size_t getGlobalIndex(size_t x, size_t y) const;
#ifndef SWIG
- //! Keeps RegionOfInterest (ROI) data of one axis
+ //! Keeps RegionOfInterest (ROI) data of one axis.
struct RoiOfAxis {
double lower;
double upper;
--
GitLab