STYLE: Add Doxygen to constructors and operator() on new algorithm classes

Add @brief, @param, and @return documentation to public constructors
and operator()() methods on FillBadData, FillBadDataBFS, FillBadDataCCL,
IdentifySampleBFS, and IdentifySampleCCL per doxygen-comments skill.

Author: joeykleingers

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/Algorithms/FillBadData.hpp

@@ -32,6 +32,13 @@ struct SIMPLNXCORE_EXPORT FillBadDataInputValues
 class SIMPLNXCORE_EXPORT FillBadData
 {
 public:
+  /**
+   * @brief Constructs the dispatcher with the required context for algorithm selection.
+   * @param dataStructure The data structure containing the arrays to process.
+   * @param mesgHandler Handler for progress and informational messages.
+   * @param shouldCancel Cancellation flag checked during execution.
+   * @param inputValues Filter parameter values controlling fill behavior.
+   */
   FillBadData(DataStructure& dataStructure, const IFilter::MessageHandler& mesgHandler, const std::atomic_bool& shouldCancel, const FillBadDataInputValues* inputValues);
   ~FillBadData() noexcept;
 
@@ -40,6 +47,10 @@ class SIMPLNXCORE_EXPORT FillBadData
   FillBadData& operator=(const FillBadData&) = delete;
   FillBadData& operator=(FillBadData&&) noexcept = delete;
 
+  /**
+   * @brief Dispatches to either BFS or CCL algorithm based on data residency.
+   * @return Result indicating success or an error with a descriptive message.
+   */
   Result<> operator()();
 
 private:

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/Algorithms/FillBadDataBFS.hpp

@@ -26,6 +26,13 @@ struct FillBadDataInputValues;
 class SIMPLNXCORE_EXPORT FillBadDataBFS
 {
 public:
+  /**
+   * @brief Constructs the BFS fill algorithm with the required context.
+   * @param dataStructure The data structure containing the arrays to process.
+   * @param mesgHandler Handler for progress and informational messages.
+   * @param shouldCancel Cancellation flag checked during execution.
+   * @param inputValues Filter parameter values controlling fill behavior.
+   */
   FillBadDataBFS(DataStructure& dataStructure, const IFilter::MessageHandler& mesgHandler, const std::atomic_bool& shouldCancel, const FillBadDataInputValues* inputValues);
   ~FillBadDataBFS() noexcept;
 
@@ -34,6 +41,10 @@ class SIMPLNXCORE_EXPORT FillBadDataBFS
   FillBadDataBFS& operator=(const FillBadDataBFS&) = delete;
   FillBadDataBFS& operator=(FillBadDataBFS&&) noexcept = delete;
 
+  /**
+   * @brief Executes the BFS flood-fill algorithm to identify and fill bad data regions.
+   * @return Result indicating success or an error with a descriptive message.
+   */
   Result<> operator()();
 
 private:

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/Algorithms/FillBadDataCCL.hpp

@@ -34,6 +34,13 @@ struct FillBadDataInputValues;
 class SIMPLNXCORE_EXPORT FillBadDataCCL
 {
 public:
+  /**
+   * @brief Constructs the CCL fill algorithm with the required context.
+   * @param dataStructure The data structure containing the arrays to process.
+   * @param mesgHandler Handler for progress and informational messages.
+   * @param shouldCancel Cancellation flag checked during execution.
+   * @param inputValues Filter parameter values controlling fill behavior.
+   */
   FillBadDataCCL(DataStructure& dataStructure, const IFilter::MessageHandler& mesgHandler, const std::atomic_bool& shouldCancel, const FillBadDataInputValues* inputValues);
   ~FillBadDataCCL() noexcept;
 
@@ -42,8 +49,16 @@ class SIMPLNXCORE_EXPORT FillBadDataCCL
   FillBadDataCCL& operator=(const FillBadDataCCL&) = delete;
   FillBadDataCCL& operator=(FillBadDataCCL&&) noexcept = delete;
 
+  /**
+   * @brief Executes the CCL-based algorithm to identify and fill bad data regions.
+   * @return Result indicating success or an error with a descriptive message.
+   */
   Result<> operator()();
 
+  /**
+   * @brief Returns the cancellation flag reference.
+   * @return Reference to the atomic cancellation flag.
+   */
   const std::atomic_bool& getCancel() const;
 
 private:

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/Algorithms/IdentifySampleBFS.hpp

@@ -26,6 +26,13 @@ struct IdentifySampleInputValues;
 class SIMPLNXCORE_EXPORT IdentifySampleBFS
 {
 public:
+  /**
+   * @brief Constructs the BFS sample identification algorithm with the required context.
+   * @param dataStructure The data structure containing the arrays to process.
+   * @param mesgHandler Handler for progress and informational messages.
+   * @param shouldCancel Cancellation flag checked during execution.
+   * @param inputValues Filter parameter values controlling identification behavior.
+   */
   IdentifySampleBFS(DataStructure& dataStructure, const IFilter::MessageHandler& mesgHandler, const std::atomic_bool& shouldCancel, const IdentifySampleInputValues* inputValues);
   ~IdentifySampleBFS() noexcept;
 
@@ -34,6 +41,10 @@ class SIMPLNXCORE_EXPORT IdentifySampleBFS
   IdentifySampleBFS& operator=(const IdentifySampleBFS&) = delete;
   IdentifySampleBFS& operator=(IdentifySampleBFS&&) noexcept = delete;
 
+  /**
+   * @brief Executes the BFS flood-fill algorithm to identify the largest sample region.
+   * @return Result indicating success or an error with a descriptive message.
+   */
   Result<> operator()();
 
 private:

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/Algorithms/IdentifySampleCCL.hpp

@@ -30,6 +30,13 @@ struct IdentifySampleInputValues;
 class SIMPLNXCORE_EXPORT IdentifySampleCCL
 {
 public:
+  /**
+   * @brief Constructs the CCL sample identification algorithm with the required context.
+   * @param dataStructure The data structure containing the arrays to process.
+   * @param mesgHandler Handler for progress and informational messages.
+   * @param shouldCancel Cancellation flag checked during execution.
+   * @param inputValues Filter parameter values controlling identification behavior.
+   */
   IdentifySampleCCL(DataStructure& dataStructure, const IFilter::MessageHandler& mesgHandler, const std::atomic_bool& shouldCancel, const IdentifySampleInputValues* inputValues);
   ~IdentifySampleCCL() noexcept;
 
@@ -38,6 +45,10 @@ class SIMPLNXCORE_EXPORT IdentifySampleCCL
   IdentifySampleCCL& operator=(const IdentifySampleCCL&) = delete;
   IdentifySampleCCL& operator=(IdentifySampleCCL&&) noexcept = delete;
 
+  /**
+   * @brief Executes the CCL-based algorithm to identify the largest sample region.
+   * @return Result indicating success or an error with a descriptive message.
+   */
   Result<> operator()();
 
 private: