Make text in the Scaladoc begin on the first line of the comment

julianmendez · Dec 30, 2017 · ab6bfb7 · ab6bfb7
1 parent 083b3c6
commit ab6bfb7
Show file tree

Hide file tree

Showing 73 changed files with 150 additions and 300 deletions.
diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/CompositeType.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/CompositeType.scala
@@ -3,21 +3,18 @@ package de.tudresden.inf.lat.tabulas.datatype
 
 import scala.collection.mutable
 
-/**
-  * This models a composite type.
+/** This models a composite type.
   *
   */
 trait CompositeType extends DataType {
 
-  /**
-    * Returns all the fields.
+  /** Returns all the fields.
     *
     * @return all the fields
     */
   def getFields: mutable.Buffer[String]
 
-  /**
-    * Returns an optional containing the type of the given field, if the field
+  /** Returns an optional containing the type of the given field, if the field
     * is present, or an empty optional otherwise.
     *
     * @param field

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/CompositeTypeImpl.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/CompositeTypeImpl.scala
@@ -6,17 +6,15 @@ import java.util.Objects
 import scala.collection.mutable
 import scala.collection.mutable.ArrayBuffer
 
-/**
-  * Default implementation of a composite type.
+/** Default implementation of a composite type.
   *
   */
 class CompositeTypeImpl extends CompositeType {
 
   private val _fields: mutable.Buffer[String] = new ArrayBuffer[String]
   private val _fieldType: mutable.Map[String, String] = new mutable.TreeMap[String, String]
 
-  /**
-    * Constructs a new composite type using another one.
+  /** Constructs a new composite type using another one.
     *
     * @param otherType
     * other type
@@ -36,8 +34,7 @@ class CompositeTypeImpl extends CompositeType {
     this._fieldType.get(field)
   }
 
-  /**
-    * Declares a field.
+  /** Declares a field.
     *
     * @param field
     * field name

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/CompositeTypeValue.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/CompositeTypeValue.scala
@@ -3,36 +3,31 @@ package de.tudresden.inf.lat.tabulas.datatype
 
 import scala.collection.mutable
 
-/**
-  * This models a composite type value.
+/** This models a composite type value.
   *
   */
 trait CompositeTypeValue {
 
-  /**
-    * Returns the type of this composite type value.
+  /** Returns the type of this composite type value.
     *
     * @return the type of this composite type value
     */
   def getType: CompositeType
 
-  /**
-    * Sets the type of this composite type value.
+  /** Sets the type of this composite type value.
     *
     * @param newType
     * type
     */
   def setType(newType: CompositeType): Unit
 
-  /**
-    * Returns all the records.
+  /** Returns all the records.
     *
     * @return all the records
     */
   def getRecords: mutable.Buffer[Record]
 
-  /**
-    * Adds a record. Returns <code>true</code> if and only if this composite
+  /** Adds a record. Returns <code>true</code> if and only if this composite
     * type value changed as a result of the call.
     *
     * @param record
@@ -42,8 +37,7 @@ trait CompositeTypeValue {
     */
   def add(record: Record): Boolean
 
-  /**
-    * Removes all of the records from this composite type value.
+  /** Removes all of the records from this composite type value.
     */
   def clear(): Unit
 

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/DataType.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/DataType.scala
@@ -1,8 +1,7 @@
 
 package de.tudresden.inf.lat.tabulas.datatype
 
-/**
-  * This models a data type.
+/** This models a data type.
   *
   */
 trait DataType {

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/DecimalType.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/DecimalType.scala
@@ -1,8 +1,7 @@
 
 package de.tudresden.inf.lat.tabulas.datatype
 
-/**
-  * This models the primitive data type Decimal.
+/** This models the primitive data type Decimal.
   *
   */
 class DecimalType extends PrimitiveType {

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/DecimalValue.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/DecimalValue.scala
@@ -7,16 +7,14 @@ import java.util.Objects
 import scala.collection.mutable
 import scala.collection.mutable.ArrayBuffer
 
-/**
-  * This models a decimal value.
+/** This models a decimal value.
   *
   */
 class DecimalValue extends PrimitiveTypeValue {
 
   private var _number: BigDecimal = BigDecimal.ZERO
 
-  /**
-    * Constructs a new decimal value using a string.
+  /** Constructs a new decimal value using a string.
     *
     * @param str
     * string
@@ -34,8 +32,7 @@ class DecimalValue extends PrimitiveTypeValue {
     }
   }
 
-  /**
-    * Constructs a new decimal value using another decimal value.
+  /** Constructs a new decimal value using another decimal value.
     *
     * @param other
     * a decimal value

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/EmptyType.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/EmptyType.scala
@@ -1,8 +1,7 @@
 
 package de.tudresden.inf.lat.tabulas.datatype
 
-/**
-  * This models the primitive data type Empty.
+/** This models the primitive data type Empty.
   *
   */
 class EmptyType extends PrimitiveType {

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/EmptyValue.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/EmptyValue.scala
@@ -4,8 +4,7 @@ package de.tudresden.inf.lat.tabulas.datatype
 import scala.collection.mutable
 import scala.collection.mutable.ArrayBuffer
 
-/**
-  * This models a empty value.
+/** This models a empty value.
   *
   */
 class EmptyValue extends PrimitiveTypeValue {

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/IntegerType.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/IntegerType.scala
@@ -1,8 +1,7 @@
 
 package de.tudresden.inf.lat.tabulas.datatype
 
-/**
-  * This models the primitive data type Integer.
+/** This models the primitive data type Integer.
   *
   */
 class IntegerType extends PrimitiveType {

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/IntegerValue.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/IntegerValue.scala
@@ -7,16 +7,14 @@ import java.util.Objects
 import scala.collection.mutable
 import scala.collection.mutable.ArrayBuffer
 
-/**
-  * This models a integer value.
+/** This models a integer value.
   *
   */
 class IntegerValue extends PrimitiveTypeValue {
 
   private var _number: BigInteger = BigInteger.ZERO
 
-  /**
-    * Constructs a new integer value using a string.
+  /** Constructs a new integer value using a string.
     *
     * @param str
     * string
@@ -34,8 +32,7 @@ class IntegerValue extends PrimitiveTypeValue {
     }
   }
 
-  /**
-    * Constructs a new integer value using another integer value.
+  /** Constructs a new integer value using another integer value.
     *
     * @param other
     * an integer value

diff --git a/...las-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/ParameterizedListType.scala b/...las-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/ParameterizedListType.scala
@@ -3,8 +3,7 @@ package de.tudresden.inf.lat.tabulas.datatype
 
 import java.util.{Objects, StringTokenizer}
 
-/**
-  * This models the type of a list of elements with a parameterized type.
+/** This models the type of a list of elements with a parameterized type.
   *
   */
 class ParameterizedListType extends PrimitiveType {

diff --git a/...as-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/ParameterizedListValue.scala b/...as-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/ParameterizedListValue.scala
@@ -6,8 +6,7 @@ import java.util.Objects
 import scala.collection.mutable
 import scala.collection.mutable.ArrayBuffer
 
-/**
-  * This models a list of elements with a parameterized type.
+/** This models a list of elements with a parameterized type.
   *
   */
 class ParameterizedListValue extends ArrayBuffer[PrimitiveTypeValue] with PrimitiveTypeValue {
@@ -18,8 +17,7 @@ class ParameterizedListValue extends ArrayBuffer[PrimitiveTypeValue] with Primit
 
   private var _parameter: PrimitiveType = _
 
-  /**
-    * Constructs a new parameterized list value.
+  /** Constructs a new parameterized list value.
     *
     * @param parameter
     * primitive type
@@ -30,8 +28,7 @@ class ParameterizedListValue extends ArrayBuffer[PrimitiveTypeValue] with Primit
     this._parameter = parameter
   }
 
-  /**
-    * Constructs a new parameterized list value using another parameterized
+  /** Constructs a new parameterized list value using another parameterized
     * list value.
     *
     * @param other

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/ParseException.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/ParseException.scala
@@ -1,7 +1,6 @@
 package de.tudresden.inf.lat.tabulas.datatype
 
-/**
-  * Parse exception.
+/** Parse exception.
   */
 class ParseException(message: String = "", cause: Throwable = null) extends RuntimeException(message, cause)
 
diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/PrimitiveType.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/PrimitiveType.scala
@@ -1,28 +1,24 @@
 
 package de.tudresden.inf.lat.tabulas.datatype
 
-/**
-  * This models a primitive type.
+/** This models a primitive type.
   *
   */
 trait PrimitiveType extends DataType {
 
-  /**
-    * Returns the name of this type.
+  /** Returns the name of this type.
     *
     * @return the name of this type
     */
   def getTypeName: String
 
-  /**
-    * Tells whether this type is a list.
+  /** Tells whether this type is a list.
     *
     * @return <code>true</code> if and only if this type is a list
     */
   def isList: Boolean
 
-  /**
-    * Returns a value based on the given string.
+  /** Returns a value based on the given string.
     *
     * @param str
     * string

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/PrimitiveTypeFactory.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/PrimitiveTypeFactory.scala
@@ -2,8 +2,7 @@ package de.tudresden.inf.lat.tabulas.datatype
 
 import scala.collection.mutable
 
-/**
-  * This models a factory of primitive types.
+/** This models a factory of primitive types.
   *
   */
 class PrimitiveTypeFactory {
@@ -14,8 +13,7 @@ class PrimitiveTypeFactory {
     this._map.put(primType.getTypeName, primType)
   }
 
-  /**
-    * Constructs a new primitive type factory.
+  /** Constructs a new primitive type factory.
     */
   {
     add(new EmptyType())
@@ -29,8 +27,7 @@ class PrimitiveTypeFactory {
     add(new ParameterizedListType(new DecimalType()))
   }
 
-  /**
-    * Tells whether this factory contains the given primitive type.
+  /** Tells whether this factory contains the given primitive type.
     *
     * @param primType
     * primitive type
@@ -41,8 +38,7 @@ class PrimitiveTypeFactory {
     return this._map.get(primType).isDefined
   }
 
-  /**
-    * Returns a new value of the specified type.
+  /** Returns a new value of the specified type.
     *
     * @param typeName
     * type name

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/PrimitiveTypeValue.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/datatype/PrimitiveTypeValue.scala
@@ -3,35 +3,30 @@ package de.tudresden.inf.lat.tabulas.datatype
 
 import scala.collection.mutable
 
-/**
-  * This models a value of a primitive type.
+/** This models a value of a primitive type.
   *
   */
 trait PrimitiveTypeValue extends Comparable[PrimitiveTypeValue] {
 
-  /**
-    * Returns the primitive type
+  /** Returns the primitive type
     *
     * @return the primitive type
     */
   def getType: PrimitiveType
 
-  /**
-    * Returns a string representing this value.
+  /** Returns a string representing this value.
     *
     * @return a string representing this value
     */
   def render(): String
 
-  /**
-    * Returns a list of strings representing this value.
+  /** Returns a list of strings representing this value.
     *
     * @return a list of strings representing this value
     */
   def renderAsList(): mutable.Buffer[String]
 
-  /**
-    * Tell whether this value represents an empty value.
+  /** Tell whether this value represents an empty value.
     *
     * @return <code>true</code> if and only if this value represents an empty
     *         value