Improve Scaladoc

Author: Atry

plugins-Builtins/src/main/scala-2.11/com/thoughtworks/deeplearning/plugins/Builtins.scala

@@ -2,7 +2,7 @@ package com.thoughtworks.deeplearning.plugins
 
 /** A plugin that enables all other DeepLearning.scala built-in plugins.
   *
-  * @example When creating a [[Builtins]] from [[com.thoughtworks.feature.Factory]],
+  * @example When creating a [[Builtins]] from [[com.thoughtworks.feature.Factory$.apply Factory]],
   *
   *          {{{
   *          import com.thoughtworks.feature.Factory

plugins-FloatWeights/src/main/scala/com/thoughtworks/deeplearning/plugins/FloatWeights.scala

@@ -23,6 +23,8 @@ trait FloatWeights extends Weights {
     override protected type Optimizer = FloatOptimizer
 
   }
+
+  /** @template */
   type FloatWeight <: FloatWeightApi with Weight
 
   @inject
@@ -42,7 +44,7 @@ trait FloatWeights extends Weights {
 
   trait FloatOptimizerApi extends OptimizerApi { this: FloatOptimizer =>
 
-    type Delta = Float
+    override type Delta = Float
 
     override protected type Weight = FloatWeight
 
@@ -55,6 +57,8 @@ trait FloatWeights extends Weights {
     }
 
   }
+
+  /** @template */
   type FloatOptimizer <: FloatOptimizerApi with Optimizer
 
 }

plugins-INDArrayWeights/build.sbt

@@ -16,3 +16,5 @@ libraryDependencies ++= {
         "org.nd4j" % "nd4j-native-platform" % "0.8.0" % Test)
   }
 }
+
+enablePlugins(Example)

plugins-INDArrayWeights/src/main/scala-2.11/com/thoughtworks/deeplearning/plugins/INDArrayWeights.scala

@@ -12,15 +12,16 @@ import annotation.meta.getter
 import scala.concurrent.ExecutionContext
 import scalaz.syntax.all._
 
-/**
+/** A plugin to create [[org.nd4j.linalg.api.ndarray.INDArray INDArray]] weight.
+  *
   * @author 杨博 (Yang Bo)
   */
 trait INDArrayWeights extends Weights with ImplicitsSingleton {
 
   @inject
   implicit protected def deepLearningExecutionContext: ExecutionContext
 
-  type Implicits <: ImplicitsApi
+  override type Implicits <: ImplicitsApi
 
   import implicits._
 
@@ -31,6 +32,8 @@ trait INDArrayWeights extends Weights with ImplicitsSingleton {
     override protected type Optimizer = INDArrayOptimizer
 
   }
+
+  /** @template */
   type INDArrayWeight <: INDArrayWeightApi with Weight
 
   @inject
@@ -50,7 +53,7 @@ trait INDArrayWeights extends Weights with ImplicitsSingleton {
 
   trait INDArrayOptimizerApi extends OptimizerApi { this: INDArrayOptimizer =>
 
-    type Delta = INDArray
+    override type Delta = INDArray
 
     override protected type Weight = INDArrayWeight
 
@@ -64,6 +67,8 @@ trait INDArrayWeights extends Weights with ImplicitsSingleton {
     }
 
   }
+
+  /** @template */
   type INDArrayOptimizer <: INDArrayOptimizerApi with Optimizer
 
 }

plugins-ImplicitsSingleton/src/main/scala/com/thoughtworks/deeplearning/plugins/ImplicitsSingleton.scala

@@ -7,6 +7,10 @@ import Factory.inject
 
 import scala.annotation.meta.getter
 
+/** A plugin that creates the instance of [[implicits]].
+  *
+  * Any fields and methods in [[Implicits]] added by other plugins will be mixed-in and present in [[implicits]].
+  */
 trait ImplicitsSingleton {
   type Implicits
 

plugins-Layers/src/main/scala/com/thoughtworks/deeplearning/plugins/Layers.scala

@@ -25,6 +25,8 @@ trait Layers {
     protected def handleException(thrown: Throwable): Unit = ()
 
   }
+
+  /** @template */
   type Layer <: LayerApi
   object Layer {
     type Aux[Data0, Delta0] = Layer {
@@ -46,6 +48,7 @@ trait Layers {
     }
   }
 
+  /** @template */
   type Implicits <: ImplicitsApi
 
 }

plugins-Logging/src/main/scala/com/thoughtworks/deeplearning/plugins/Logging.scala

@@ -58,7 +58,8 @@ object Logging {
 
 }
 
-/**
+/** A plugin that logs uncaught exceptions raised from [[Layer]] and [[Weight]].
+  *
   * @author 杨博 (Yang Bo)
   */
 trait Logging extends Layers with Weights {
@@ -78,15 +79,15 @@ trait Logging extends Layers with Weights {
       logger.log(new ThrownInLayer(this, thrown))
     }
   }
-  type Layer <: LayerApi
+  override type Layer <: LayerApi
 
   trait WeightApi extends super.WeightApi with LoggingContext { this: Weight =>
     override protected def handleException(thrown: Throwable): Unit = {
       super.handleException(thrown)
       logger.log(new ThrownInWeight(this, thrown))
     }
   }
-  type Weight <: WeightApi
+  override type Weight <: WeightApi
   override type Implicits <: super[Layers].ImplicitsApi with super[Weights].ImplicitsApi
 
 }

plugins-Operators/src/main/scala/com/thoughtworks/deeplearning/plugins/Operators.scala

@@ -2,7 +2,7 @@ package com.thoughtworks.deeplearning
 package plugins
 import shapeless.{Poly1, Poly2}
 
-/** A namespace of definitions of polymorphic operators.
+/** A plugin of definitions of polymorphic operators.
   *
   * Those functions are implemented in [[RawFloatLayers]], [[RawDoubleLayers]] and [[RawINDArrayLayers]].
   * @author 杨博 (Yang Bo)
@@ -45,6 +45,8 @@ trait Operators {
 
     }
   }
+
+  /** @template */
   type Implicits <: ImplicitsApi
 
 }

plugins-RawFloatLayers/src/main/scala-2.11/com/thoughtworks/deeplearning/plugins/RawFloatLayers.scala

@@ -202,6 +202,7 @@ trait RawFloatLayers extends Layers {
 
   override type Implicits <: ImplicitsApi
 
+  /** @template */
   type FloatLayer <: FloatLayerApi with Layer
 
   @inject

plugins-RawINDArrayLayers/src/main/scala-2.11/com/thoughtworks/deeplearning/plugins/RawINDArrayLayers.scala

@@ -577,6 +577,7 @@ trait RawINDArrayLayers extends RawDoubleLayers with DoubleLiterals with Implici
 
   override type Implicits <: ImplicitsApi
 
+  /** @template */
   type INDArrayLayer <: INDArrayLayerApi with Layer
 
   @inject