Update doxygen

tiledb/sm/filter/bit_width_reduction_filter.h

@@ -82,12 +82,18 @@ namespace sm {
  */
 class BitWidthReductionFilter : public Filter {
  public:
-  /** Constructor. */
+  /**
+   * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
+   */
   BitWidthReductionFilter(Datatype filter_data_type);
 
-  /** Constructor.
+  /**
+   * Constructor.
    *
-   * @param max_window_size
+   * @param max_window_size Window size in bytes to apply bit width reduction.
+   * @param filter_data_type Datatype the filter will operate on.
    */
   BitWidthReductionFilter(uint32_t max_window_size, Datatype filter_data_type);
 
@@ -97,7 +103,7 @@ class BitWidthReductionFilter : public Filter {
   /**
    * Checks if the filter is applicable to the input datatype.
    *
-   * @param type Input datatype to check filter compatibility.
+   * @param datatype Input datatype to check filter compatibility.
    */
   bool accepts_input_datatype(Datatype datatype) const override;
 

tiledb/sm/filter/bitshuffle_filter.h

@@ -76,6 +76,8 @@ class BitshuffleFilter : public Filter {
  public:
   /**
    * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   BitshuffleFilter(Datatype filter_data_type);
 

tiledb/sm/filter/byteshuffle_filter.h

@@ -68,6 +68,8 @@ class ByteshuffleFilter : public Filter {
  public:
   /**
    * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   ByteshuffleFilter(Datatype filter_data_type);
 

tiledb/sm/filter/checksum_md5_filter.h

@@ -73,6 +73,8 @@ class ChecksumMD5Filter : public Filter {
  public:
   /**
    * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   ChecksumMD5Filter(Datatype filter_data_type);
 

tiledb/sm/filter/checksum_sha256_filter.h

@@ -74,6 +74,8 @@ class ChecksumSHA256Filter : public Filter {
  public:
   /**
    * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   ChecksumSHA256Filter(Datatype filter_data_type);
 

tiledb/sm/filter/compression_filter.h

@@ -84,6 +84,7 @@ class CompressionFilter : public Filter {
    *
    * @param compressor Compressor to use
    * @param level Compression level to use
+   * @param filter_data_type Datatype the compressor will operate on.
    * @param reinterpret_type Type to reinterpret data prior to compression.
    * @param version Format version
    */
@@ -99,6 +100,7 @@ class CompressionFilter : public Filter {
    *
    * @param compressor Compressor to use
    * @param level Compression level to use
+   * @param filter_data_type Datatype the compressor will operate on.
    * @param reinterpret_type Type to reinterpret data prior to compression.
    * @param version Format version
    */
@@ -251,8 +253,10 @@ class CompressionFilter : public Filter {
   /** Initializes the decompression resource pool */
   void init_decompression_resource_pool(uint64_t size) override;
 
-  /** Creates a vector of views of the input strings and returns the max string
-   * size */
+  /**
+   * Creates a vector of views of the input strings and returns the max string
+   * size
+   */
   static tuple<std::vector<std::string_view>, uint64_t> create_input_view(
       const FilterBuffer& input, WriterTile* const offsets_tile);
 
@@ -265,7 +269,7 @@ class CompressionFilter : public Filter {
   static uint8_t compute_bytesize(uint64_t param_length);
 
   /**
-   * @brief Returns the filter output type
+   * Returns the filter output type
    *
    * @param input_type Expected type used for input. Used for filters which
    * change output type based on input data. e.g. XORFilter output type is

tiledb/sm/filter/encryption_aes256gcm_filter.h

@@ -80,13 +80,16 @@ class EncryptionAES256GCMFilter : public Filter {
  public:
   /**
    * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   EncryptionAES256GCMFilter(Datatype filter_data_type);
 
   /**
    * Constructor with explicit key.
    *
    * @param key Key to use for the filter.
+   * @param filter_data_type Datatype the filter will operate on.
    */
   explicit EncryptionAES256GCMFilter(
       const EncryptionKey& key, Datatype filter_data_type);

tiledb/sm/filter/filter.h

@@ -62,7 +62,11 @@ enum class Datatype : uint8_t;
  */
 class Filter {
  public:
-  /** Constructor. */
+  /**
+   * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
+   */
   explicit Filter(FilterType type, Datatype filter_data_type);
 
   /** Destructor. */
@@ -78,7 +82,7 @@ class Filter {
   virtual void dump(FILE* out) const = 0;
 
   /**
-   * @brief Returns the filter output type
+   * Returns the filter output type
    *
    * @param input_type Expected type used for input. Used for filters which
    * change output type based on input data. e.g. XORFilter output type is
@@ -87,14 +91,14 @@ class Filter {
   virtual Datatype output_datatype(Datatype input_type) const;
 
   /**
-   * @brief Throws if given data type *cannot* be handled by this filter.
+   * Throws if given data type *cannot* be handled by this filter.
    *
    * @param datatype Input datatype to check filter compatibility.
    */
   void ensure_accepts_datatype(Datatype datatype) const;
 
   /**
-   * @brief Checks if the filter is applicable to the input datatype.
+   * Checks if the filter is applicable to the input datatype.
    *
    * @param type Input datatype to check filter compatibility.
    */

tiledb/sm/filter/float_scaling_filter.h

@@ -66,6 +66,8 @@ class FloatScalingFilter : public Filter {
   /**
    * Default constructor. Default settings for Float Scaling Filter are
    * scale = 1.0f, offset = 0.0f, and byte_width = 8.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   FloatScalingFilter(Datatype filter_data_type)
       : Filter(FilterType::FILTER_SCALE_FLOAT, filter_data_type)
@@ -80,6 +82,7 @@ class FloatScalingFilter : public Filter {
    * @param byte_width The byte width of the compressed representation.
    * @param scale The scale factor.
    * @param offset The offset factor.
+   * @param filter_data_type Datatype the filter will operate on.
    */
   FloatScalingFilter(
       uint64_t byte_width,
@@ -139,7 +142,7 @@ class FloatScalingFilter : public Filter {
   bool accepts_input_datatype(Datatype datatype) const override;
 
   /**
-   * @brief Returns the filter output type
+   * Returns the filter output type
    *
    * @param input_type Expected type used for input. Used for filters which
    * change output type based on input data. e.g. XORFilter output type is

tiledb/sm/filter/noop_filter.h

@@ -48,6 +48,8 @@ class NoopFilter : public Filter {
  public:
   /**
    * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   NoopFilter(Datatype filter_data_type);
 

tiledb/sm/filter/positive_delta_filter.h

@@ -73,12 +73,18 @@ namespace sm {
  */
 class PositiveDeltaFilter : public Filter {
  public:
-  /** Constructor. */
+  /**
+   * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
+   */
   PositiveDeltaFilter(Datatype filter_data_type);
 
-  /** Constructor.
+  /**
+   * Constructor.
    *
-   * @param max_window_size
+   * @param max_window_size Window size in bytes to apply positive delta filter.
+   * @param filter_data_type Datatype the filter will operate on.
    */
   PositiveDeltaFilter(uint32_t max_window_size, Datatype filter_data_type);
 

tiledb/sm/filter/webp_filter.h

@@ -107,20 +107,26 @@ class WebpFilter : public Filter {
   /* ********************************* */
 
   /**
+   * Constructor.
    * Default setting for webp quality factor is 100.0 for lossy compression.
    * Caller must set colorspace format filter option.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   WebpFilter(Datatype filter_data_type)
       : WebpFilter(
             100.0f, WebpInputFormat::WEBP_NONE, false, 0, 0, filter_data_type) {
   }
 
   /**
+   * Constructor.
+   *
    * @param quality Quality factor to use for WebP lossy compression.
    * @param inputFormat Colorspace format to use for WebP compression.
    * @param lossless Enable lossless compression.
    * @param y_extent Extent at dimension index 0.
    * @param x_extent Extent at dimension index 1.
+   * @param filter_data_type Datatype the filter will operate on.
    */
   WebpFilter(
       float quality,

tiledb/sm/filter/xor_filter.h

@@ -58,7 +58,9 @@ namespace sm {
 class XORFilter : public Filter {
  public:
   /**
-   * Default constructor.
+   * Constructor.
+   *
+   * @param filter_data_type Datatype the filter will operate on.
    */
   XORFilter(Datatype filter_data_type)
       : Filter(FilterType::FILTER_XOR, filter_data_type) {
@@ -75,7 +77,7 @@ class XORFilter : public Filter {
   bool accepts_input_datatype(Datatype datatype) const override;
 
   /**
-   * @brief Returns the filter output type
+   * Returns the filter output type
    *
    * @param input_type Expected type used for input. Used for filters which
    * change output type based on input data. e.g. XORFilter output type is