Skip to content

Commit 74fb433

Browse files
rxinmarmbrus
authored andcommitted
Minor doc: Remove the extra blank line in data types javadoc.
The extra blank line is preventing the first lines from showing up in the package summary page. Author: Reynold Xin <[email protected]> Closes apache#4955 from rxin/datatype-docs and squashes the following commits: 1621114 [Reynold Xin] Minor doc: Remove the extra blank line in data types javadoc.
1 parent 7c7d2d5 commit 74fb433

File tree

1 file changed

+6
-18
lines changed

1 file changed

+6
-18
lines changed

sql/catalyst/src/main/scala/org/apache/spark/sql/types/dataTypes.scala

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,6 @@ object DataType {
240240

241241
/**
242242
* :: DeveloperApi ::
243-
*
244243
* The base type of all Spark SQL data types.
245244
*
246245
* @group dataType
@@ -282,7 +281,6 @@ abstract class DataType {
282281

283282
/**
284283
* :: DeveloperApi ::
285-
*
286284
* The data type representing `NULL` values. Please use the singleton [[DataTypes.NullType]].
287285
*
288286
* @group dataType
@@ -342,7 +340,6 @@ protected[sql] abstract class NativeType extends DataType {
342340

343341
/**
344342
* :: DeveloperApi ::
345-
*
346343
* The data type representing `String` values. Please use the singleton [[DataTypes.StringType]].
347344
*
348345
* @group dataType
@@ -369,7 +366,6 @@ case object StringType extends StringType
369366

370367
/**
371368
* :: DeveloperApi ::
372-
*
373369
* The data type representing `Array[Byte]` values.
374370
* Please use the singleton [[DataTypes.BinaryType]].
375371
*
@@ -405,7 +401,6 @@ case object BinaryType extends BinaryType
405401

406402
/**
407403
* :: DeveloperApi ::
408-
*
409404
* The data type representing `Boolean` values. Please use the singleton [[DataTypes.BooleanType]].
410405
*
411406
*@group dataType
@@ -432,7 +427,6 @@ case object BooleanType extends BooleanType
432427

433428
/**
434429
* :: DeveloperApi ::
435-
*
436430
* The data type representing `java.sql.Timestamp` values.
437431
* Please use the singleton [[DataTypes.TimestampType]].
438432
*
@@ -464,7 +458,6 @@ case object TimestampType extends TimestampType
464458

465459
/**
466460
* :: DeveloperApi ::
467-
*
468461
* The data type representing `java.sql.Date` values.
469462
* Please use the singleton [[DataTypes.DateType]].
470463
*
@@ -492,6 +485,12 @@ class DateType private() extends NativeType {
492485
case object DateType extends DateType
493486

494487

488+
/**
489+
* :: DeveloperApi ::
490+
* Numeric data types.
491+
*
492+
* @group dataType
493+
*/
495494
abstract class NumericType extends NativeType with PrimitiveType {
496495
// Unfortunately we can't get this implicitly as that breaks Spark Serialization. In order for
497496
// implicitly[Numeric[JvmType]] to be valid, we have to change JvmType from a type variable to a
@@ -523,7 +522,6 @@ protected[sql] sealed abstract class IntegralType extends NumericType {
523522

524523
/**
525524
* :: DeveloperApi ::
526-
*
527525
* The data type representing `Long` values. Please use the singleton [[DataTypes.LongType]].
528526
*
529527
* @group dataType
@@ -554,7 +552,6 @@ case object LongType extends LongType
554552

555553
/**
556554
* :: DeveloperApi ::
557-
*
558555
* The data type representing `Int` values. Please use the singleton [[DataTypes.IntegerType]].
559556
*
560557
* @group dataType
@@ -585,7 +582,6 @@ case object IntegerType extends IntegerType
585582

586583
/**
587584
* :: DeveloperApi ::
588-
*
589585
* The data type representing `Short` values. Please use the singleton [[DataTypes.ShortType]].
590586
*
591587
* @group dataType
@@ -616,7 +612,6 @@ case object ShortType extends ShortType
616612

617613
/**
618614
* :: DeveloperApi ::
619-
*
620615
* The data type representing `Byte` values. Please use the singleton [[DataTypes.ByteType]].
621616
*
622617
* @group dataType
@@ -666,7 +661,6 @@ case class PrecisionInfo(precision: Int, scale: Int)
666661

667662
/**
668663
* :: DeveloperApi ::
669-
*
670664
* The data type representing `java.math.BigDecimal` values.
671665
* A Decimal that might have fixed precision and scale, or unlimited values for these.
672666
*
@@ -745,7 +739,6 @@ object DecimalType {
745739

746740
/**
747741
* :: DeveloperApi ::
748-
*
749742
* The data type representing `Double` values. Please use the singleton [[DataTypes.DoubleType]].
750743
*
751744
* @group dataType
@@ -775,7 +768,6 @@ case object DoubleType extends DoubleType
775768

776769
/**
777770
* :: DeveloperApi ::
778-
*
779771
* The data type representing `Float` values. Please use the singleton [[DataTypes.FloatType]].
780772
*
781773
* @group dataType
@@ -811,7 +803,6 @@ object ArrayType {
811803

812804
/**
813805
* :: DeveloperApi ::
814-
*
815806
* The data type for collections of multiple values.
816807
* Internally these are represented as columns that contain a ``scala.collection.Seq``.
817808
*
@@ -854,7 +845,6 @@ case class ArrayType(elementType: DataType, containsNull: Boolean) extends DataT
854845

855846
/**
856847
* A field inside a StructType.
857-
*
858848
* @param name The name of this field.
859849
* @param dataType The data type of this field.
860850
* @param nullable Indicates if values of this field can be `null` values.
@@ -949,7 +939,6 @@ object StructType {
949939

950940
/**
951941
* :: DeveloperApi ::
952-
*
953942
* A [[StructType]] object can be constructed by
954943
* {{{
955944
* StructType(fields: Seq[StructField])
@@ -1118,7 +1107,6 @@ object MapType {
11181107

11191108
/**
11201109
* :: DeveloperApi ::
1121-
*
11221110
* The data type for Maps. Keys in a map are not allowed to have `null` values.
11231111
*
11241112
* Please use [[DataTypes.createMapType()]] to create a specific instance.

0 commit comments

Comments
 (0)