From 34ee26f96d77ccfe79f3a84292dad7c4c7c57cd6 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Thu, 19 Oct 2023 10:57:34 +0200
Subject: [PATCH] Add doc-strings for List exception members
---
src/include/List.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/src/include/List.h b/src/include/List.h
index 0e13f0f9..e1544aa8 100644
--- a/src/include/List.h
+++ b/src/include/List.h
@@ -12,7 +12,12 @@
*/
class ListOutOfBoundsException: public std::exception {
protected:
- int min_index, max_index, requested_index;
+ //! \brief Minimum index defined in the list.
+ int min_index;
+ //! \brief Maximum index defined in the list.
+ int max_index;
+ //! \brief Index requested by user.
+ int requested_index;
public:
/**
--
GitLab