Update RenameMap Scaladoc for self-rename, distinc

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

1 files changed, 15 insertions, 1 deletions

diff --git a/src/main/scala/firrtl/RenameMap.scala b/src/main/scala/firrtl/RenameMap.scala
index ffb7acc2..bdcb785a 100644
--- a/src/main/scala/firrtl/RenameMap.scala
+++ b/src/main/scala/firrtl/RenameMap.scala
@@ -33,12 +33,16 @@ object RenameMap {
   *
   * Transforms that modify names should return a [[RenameMap]] with the [[CircuitState]]
   * These are mutable datastructures for convenience
+  * @define noteSelfRename @note Self renames *will* be recorded
+  * @define noteDistinct @note Rename to/tos will be made distinct
   */
 // TODO This should probably be refactored into immutable and mutable versions
 final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, Seq[CompleteTarget]] = mutable.HashMap[CompleteTarget, Seq[CompleteTarget]](), val chained: Option[RenameMap] = None) {
 
   /** Chain a [[RenameMap]] with this [[RenameMap]]
     * @param next the map to chain with this map
+    * $noteSelfRename
+    * $noteDistinct
     */
   def andThen(next: RenameMap): RenameMap = {
     if (next.chained.isEmpty) {
@@ -52,6 +56,8 @@ final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, S
     * [[firrtl.annotations.CircuitTarget CircuitTarget]]
     * @param from
     * @param to
+    * $noteSelfRename
+    * $noteDistinct
     */
   def record(from: CircuitTarget, to: CircuitTarget): Unit = completeRename(from, Seq(to))
 
@@ -59,6 +65,8 @@ final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, S
     * [[firrtl.annotations.CircuitTarget CircuitTarget]]s
     * @param from
     * @param tos
+    * $noteSelfRename
+    * $noteDistinct
     */
   def record(from: CircuitTarget, tos: Seq[CircuitTarget]): Unit = completeRename(from, tos)
 
@@ -66,6 +74,8 @@ final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, S
     * IsMember]]
     * @param from
     * @param to
+    * $noteSelfRename
+    * $noteDistinct
     */
   def record(from: IsMember, to: IsMember): Unit = completeRename(from, Seq(to))
 
@@ -73,6 +83,8 @@ final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, S
     * [[firrtl.annotations.IsMember IsMember]]s
     * @param from
     * @param tos
+    * $noteSelfRename
+    * $noteDistinct
     */
   def record(from: IsMember, tos: Seq[IsMember]): Unit = completeRename(from, tos)
 
@@ -81,6 +93,8 @@ final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, S
     * and ([[firrtl.annotations.IsMember IsMember]] -> Seq[ [[firrtl.annotations.IsMember IsMember]] ]) key/value
     * allowed
     * @param map
+    * $noteSelfRename
+    * $noteDistinct
     */
   def recordAll(map: collection.Map[CompleteTarget, Seq[CompleteTarget]]): Unit =
     map.foreach{
@@ -479,7 +493,7 @@ final class RenameMap private (val underlying: mutable.HashMap[CompleteTarget, S
     }
   }
 
-  /** Fully renames from to tos
+  /** Fully rename `from` to `tos`
     * @param from
     * @param tos
     */