documentation fixes

src/main/kotlin/com/github/chriskn/structurizrextension/api/Workspace.kt

@@ -6,13 +6,14 @@ import com.structurizr.export.Diagram
 import java.io.BufferedWriter
 import java.io.File
 import java.io.FileWriter
+import java.io.IOException
 
 /**
  * Writes all views of the workspace as C4PlantUML diagrams to the given output folder.
  *
  * Diagrams files are named after their diagram key
  *
- * @throws IOException if writing fails.
+ * @throws [IOException] if writing fails.
  */
 fun Workspace.writeDiagrams(outputFolder: File) {
     outputFolder.mkdirs()

src/main/kotlin/com/github/chriskn/structurizrextension/api/model/Container.kt

@@ -1,5 +1,6 @@
 package com.github.chriskn.structurizrextension.api.model
 
+import com.github.chriskn.structurizrextension.api.icons.IconRegistry
 import com.structurizr.model.Component
 import com.structurizr.model.Container
 import com.structurizr.model.StaticStructureElement
@@ -10,7 +11,7 @@ import com.structurizr.model.StaticStructureElement
  * @param name          the name of the component
  * @param description   the description of the component
  * @param c4Type        the [C4Type] of the component
- * @param icon          the icon of the component. See IconRegistry for available icons or add your own
+ * @param icon          the icon of the component. See [IconRegistry] for available icons or add your own
  * @param link          the link of the component
  * @param technology    the technology of the component
  * @param tags          the list of tags of the component

src/main/kotlin/com/github/chriskn/structurizrextension/api/model/Dependency.kt

@@ -1,5 +1,6 @@
 package com.github.chriskn.structurizrextension.api.model
 
+import com.github.chriskn.structurizrextension.api.icons.IconRegistry
 import com.structurizr.model.Element
 import com.structurizr.model.InteractionStyle
 
@@ -10,7 +11,7 @@ import com.structurizr.model.InteractionStyle
  * @param description       the description of the dependency
  * @param technology        the technology of the dependency
  * @param interactionStyle  the [InteractionStyle] of the dependency
- * @param icon              the icon of the dependency. See IconRegistry for available icons or add your own
+ * @param icon              the icon of the dependency. See [IconRegistry] for available icons or add your own
  * @param link              the link of the dependency
  * @param tags              the list of tags of the dependency
  * @param properties        [C4Properties] of the dependency

src/main/kotlin/com/github/chriskn/structurizrextension/api/model/DeploymentNode.kt

@@ -1,5 +1,6 @@
 package com.github.chriskn.structurizrextension.api.model
 
+import com.github.chriskn.structurizrextension.api.icons.IconRegistry
 import com.structurizr.model.Container
 import com.structurizr.model.DeploymentElement
 import com.structurizr.model.DeploymentNode
@@ -11,7 +12,7 @@ import com.structurizr.model.SoftwareSystem
  *
  * @param name              the name of the deployment node
  * @param description       the description of the deployment node
- * @param icon              the icon of the deployment node. See IconRegistry for available icons or add your own
+ * @param icon              the icon of the deployment node. See [IconRegistry] for available icons or add your own
  * @param link              the link of the deployment node
  * @param technology        the technology of the deployment node
  * @param tags              the list of tags of the deployment node
@@ -46,7 +47,7 @@ fun DeploymentNode.deploymentNode(
  *
  * @param name              the name of the infrastructure node
  * @param description       the description of the infrastructure node
- * @param icon              the icon of the infrastructure node. See IconRegistry for available icons or add your own
+ * @param icon              the icon of the infrastructure node. See [IconRegistry] for available icons or add your own
  * @param link              the link of the infrastructure node
  * @param technology        the technology of the infrastructure node
  * @param tags              the list of tags of the infrastructure node

src/main/kotlin/com/github/chriskn/structurizrextension/api/model/Model.kt

@@ -1,5 +1,6 @@
 package com.github.chriskn.structurizrextension.api.model
 
+import com.github.chriskn.structurizrextension.api.icons.IconRegistry
 import com.structurizr.model.Container
 import com.structurizr.model.DeploymentElement
 import com.structurizr.model.DeploymentNode
@@ -25,8 +26,8 @@ var Model.enterpriseName: String?
  *
  * @param name        the name of the person (e.g. "Admin User" or "Bob the Business User")
  * @param description the description of the person
- * @param location    the [Location]] of the person
- * @param icon        the icon of the person. See IconRegistry for available icons or add your own
+ * @param location    the [Location] of the person
+ * @param icon        the icon of the person. See [IconRegistry] for available icons or add your own
  * @param link        the link of the person
  * @param tags        the list of tags of the person
  * @param properties  the [C4Properties] of the person
@@ -58,15 +59,15 @@ fun Model.person(
  *
  * @param name          the name of the system
  * @param description   the description of the system
- * @param location      the [Location]] of the system
+ * @param location      the [Location] of the system
  * @param c4Type        the [C4Type] of the system
- * @param icon          the icon of the system. See IconRegistry for available icons or add your own
+ * @param icon          the icon of the system. See [IconRegistry] for available icons or add your own
  * @param link          the link of the system
  * @param tags          the list of tags of the system
  * @param properties    the [C4Properties] of the system
  * @param uses          the list of [Dependency] to a system, container or component the system uses. A person can't be used
  * @param usedBy        the list of [Dependency] to a system, container, component or person the system is used by
- * @return the SoftwareSystem created and added to the model (or null)
+ * @return the [SoftwareSystem] created and added to the model (or null)
  * @throws IllegalArgumentException if a software system with the same name already exists or a person is used in an uses dependency
  */
 @Suppress("LongParameterList")
@@ -94,7 +95,7 @@ fun Model.softwareSystem(
  *
  * @param name              the name of the deployment node
  * @param description       the description of the deployment node
- * @param icon              the icon of the deployment node. See IconRegistry for available icons or add your own
+ * @param icon              the icon of the deployment node. See [IconRegistry] for available icons or add your own
  * @param link              the link of the deployment node
  * @param technology        the technology of the deployment node
  * @param tags              the list of tags of the deployment node
@@ -103,7 +104,7 @@ fun Model.softwareSystem(
  * @param usedBy            the list of [Dependency] to a deployment node or infrastructure node the deployment node is used by
  * @param hostsSystems      the list of systems the deployment node hosts
  * @param hostsContainers   the list of container the deployment node hosts
- * @return the resulting DeploymentNode
+ * @return the resulting [DeploymentNode]
  * @throws IllegalArgumentException if an invalid element is used in dependencies
  */
 @Suppress("LongParameterList")

src/main/kotlin/com/github/chriskn/structurizrextension/api/model/SoftwareSystem.kt

@@ -1,5 +1,6 @@
 package com.github.chriskn.structurizrextension.api.model
 
+import com.github.chriskn.structurizrextension.api.icons.IconRegistry
 import com.structurizr.model.Container
 import com.structurizr.model.Location
 import com.structurizr.model.SoftwareSystem
@@ -10,9 +11,9 @@ import com.structurizr.model.StaticStructureElement
  *
  * @param name          the name of the container
  * @param description   the description of the container
- * @param location      the [Location]] of the container
- * @param c4Type          the [C4Type] of the container
- * @param icon          the icon of the container. See IconRegistry for available icons or add your own
+ * @param location      the [Location] of the container
+ * @param c4Type        the [C4Type] of the container
+ * @param icon          the icon of the container. See [IconRegistry] for available icons or add your own
  * @param link          the link of the container
  * @param tags          the list of tags of the container
  * @param properties    the [C4Properties] of the container

src/main/kotlin/com/github/chriskn/structurizrextension/api/model/StaticStructureElement.kt

@@ -1,5 +1,6 @@
 package com.github.chriskn.structurizrextension.api.model
 
+import com.github.chriskn.structurizrextension.api.icons.IconRegistry
 import com.structurizr.model.InteractionStyle
 import com.structurizr.model.Person
 import com.structurizr.model.StaticStructureElement
@@ -11,7 +12,7 @@ import com.structurizr.model.StaticStructureElement
  * @param description       the description of the dependency
  * @param technology        the technology of the dependency
  * @param interactionStyle  the [InteractionStyle] of the dependency
- * @param icon              the icon of the dependency. See IconRegistry for available icons or add your own
+ * @param icon              the icon of the dependency. See [IconRegistry] for available icons or add your own
  * @param link              the link of the dependency
  * @param tags              the list of tags of the dependency
  * @param properties        [C4Properties] of the dependency
@@ -38,7 +39,7 @@ fun <T : StaticStructureElement> StaticStructureElement.uses(
  * @param description       the description of the dependency
  * @param technology        the technology of the dependency
  * @param interactionStyle  the [InteractionStyle] of the dependency
- * @param icon              the icon of the dependency. See IconRegistry for available icons or add your own
+ * @param icon              the icon of the dependency. See [IconRegistry] for available icons or add your own
  * @param link              the link of the dependency
  * @param tags              the list of tags of the dependency
  * @param properties        [C4Properties] of the dependency