Merge pull request filodb#34 from darkjh/feature/fix_scaladoc

velvia · velvia · commit bc4a38744a53 · 2015-10-30T10:14:51.000+01:00
fix scaladoc issues
diff --git a/coordinator/src/main/scala/filodb.coordinator/NodeCoordinatorActor.scala b/coordinator/src/main/scala/filodb.coordinator/NodeCoordinatorActor.scala
@@ -44,9 +44,10 @@ object NodeCoordinatorActor {
    * Sets up ingestion for a given dataset, version, and schema of columns.
    * The dataset and columns must have been previously defined.
    *
-   * @defaultPartitionKey if Some(key), a null value in partitioning column will cause key to be used.
-   *                      if None, then NullPartitionValue will be thrown when null value
-   *                        is encountered in a partitioning column.
+   * @param defaultPartitionKey
+   *        if Some(key), a null value in partitioning column will cause key to be used.
+   *        if None, then NullPartitionValue will be thrown when null value is encountered
+   *        in a partitioning column.
    * @return BadSchema if the partition column is unsupported, sort column invalid, etc.
    */
   case class SetupIngestion(dataset: String,
diff --git a/core/src/main/scala/filodb.core/columnstore/Segment.scala b/core/src/main/scala/filodb.core/columnstore/Segment.scala
@@ -13,7 +13,7 @@ import filodb.core.metadata.Column
 /**
  * A Segment represents columnar chunks for a given dataset, partition, range of keys, and columns.
  * It also contains an index to help read data out in sorted order.
- * For more details see [[doc/sorted_chunk_merge.md]].
+ * For more details see `doc/sorted_chunk_merge.md`.
  */
 trait Segment[K] {
   val keyRange: KeyRange[K]
