Update Scaladoc

Author: Chungmin Lee

src/main/scala/com/microsoft/hyperspace/index/IndexSignatureProvider.scala

@@ -29,6 +29,8 @@ import com.microsoft.hyperspace.util.fingerprint.{Fingerprint, FingerprintBuilde
  *
  * If the plan does not comply with [[FileBasedSignatureProvider]] or [[PlanSignatureProvider]]
  * requirements for signature computation, then no signature will be provided for the plan.
+ *
+ * @param fbf [[FingerprintBuilderFactory]] used for building fingerprints
  */
 class IndexSignatureProvider(fbf: FingerprintBuilderFactory)
     extends LogicalPlanSignatureProvider {

src/main/scala/com/microsoft/hyperspace/index/PlanSignatureProvider.scala

@@ -24,6 +24,8 @@ import com.microsoft.hyperspace.util.fingerprint.{Fingerprint, FingerprintBuilde
  * [[PlanSignatureProvider]] provides signature for a logical plan based on
  * the type of operators in it.
  * A plan needs to have at least one operator so its signature can be generated.
+ *
+ * @param fbf [[FingerprintBuilderFactory]] used for building fingerprints
  */
 class PlanSignatureProvider(fbf: FingerprintBuilderFactory) extends LogicalPlanSignatureProvider {
 

src/main/scala/com/microsoft/hyperspace/index/sources/default/DefaultFileBasedRelation.scala

@@ -41,6 +41,8 @@ class DefaultFileBasedRelation(spark: SparkSession, override val plan: LogicalRe
 
   /**
    * Computes the signature of the current relation.
+   *
+   * @param fb [[FingerprintBuilder]] used for building fingerprints
    */
   override def signature(fb: FingerprintBuilder): Option[Fingerprint] = plan.relation match {
     case HadoopFsRelation(location: PartitioningAwareFileIndex, _, _, _, _, _) =>

src/main/scala/com/microsoft/hyperspace/index/sources/delta/DeltaLakeRelation.scala

@@ -36,6 +36,8 @@ class DeltaLakeRelation(spark: SparkSession, override val plan: LogicalRelation)
 
   /**
    * Computes the signature of the current relation.
+   *
+   * @param fb [[FingerprintBuilder]] used for building fingerprints
    */
   override def signature(fb: FingerprintBuilder): Option[Fingerprint] = plan.relation match {
     case HadoopFsRelation(location: TahoeLogFileIndex, _, _, _, _, _) =>

src/main/scala/com/microsoft/hyperspace/index/sources/iceberg/IcebergRelation.scala

@@ -45,6 +45,8 @@ class IcebergRelation(spark: SparkSession, override val plan: DataSourceV2Relati
 
   /**
    * Computes the signature of the current relation.
+   *
+   * @param fb [[FingerprintBuilder]] used for building fingerprints
    */
   override def signature(fb: FingerprintBuilder): Option[Fingerprint] = plan.source match {
     case _: IcebergSource =>

src/main/scala/com/microsoft/hyperspace/index/sources/interfaces.scala

@@ -61,6 +61,9 @@ trait FileBasedRelation extends SourceRelation {
    *
    * If it is not possible to compute the signature (e.g. there are no files left),
    * the implementation might return None.
+   *
+   * @param fb [[FingerprintBuilder]] used for building fingerprints.
+   *           Use it to compute the signature from discriminating properties of the relation.
    */
   def signature(fb: FingerprintBuilder): Option[Fingerprint]