more scaladoc; cleanup

Author: tmckay-sifive

svsim/src/main/scala/Workspace.scala

@@ -50,9 +50,7 @@ final class Workspace(
     else
       s"${System.getProperty("user.dir")}/$path"
 
-  /** A directory where the user can store additional artifacts which are relevant to the primary sources (for instance,
-   *  artifacts related to the generation of primary sources). These artifacts have no impact on the simulation, but it
-   *  may be useful to group them with the other files generated by svsim for debugging purposes.
+  /** A directory where the user can store additional artifacts which are relevant to the primary sources (for instance, artifacts related to the generation of primary sources). These artifacts have no impact on the simulation, but it may be useful to group them with the other files generated by svsim for debugging purposes. artifacts related to the generation of primary sources). These artifacts have no impact on the simulation, but it may be useful to group them with the other files generated by svsim for debugging purposes.
     */
   val supportArtifactsPath = s"$absolutePath/support-artifacts"
 
@@ -102,12 +100,10 @@ final class Workspace(
     copyResource(klass, name, primarySourcesPath)
   }
 
-  /** `svsim` elaboration simply stores the provided `ModuleInfo` for use by the `compile` method.
-   *  The idea is that packages that actually do elaboration (like Chisel) will add an overload of
-   *  this method in an implicit class that then calls this method with the appropriate `ModuleInfo`.
+  /** `svsim` elaboration simply stores the provided `ModuleInfo` for use by the `compile` method. The idea is that packages that actually do elaboration (like Chisel) will add an overload of this method in an implicit class that then calls this method with the appropriate `ModuleInfo`.
     */
   def elaborate(moduleInfo: ModuleInfo) = {
-    assert(_moduleInfo.isEmpty, "moduleInfo has already been set")
+    assert(_moduleInfo.isEmpty)
     _moduleInfo = Some(moduleInfo)
   }
 
@@ -333,6 +329,9 @@ final class Workspace(
   }
   //format: on
 
+  /** Shallow copy the sources from this workspace to a new one. Primary sources are symlinked to the
+   *  new directory; nothing else is copied.
+   */
   def shallowCopy(newPath: String, workingDirectoryPrefix: String = this.workingDirectoryPrefix): Workspace = {
     val newWorkspace = new Workspace(newPath, workingDirectoryPrefix)
     newWorkspace.reset()