DOC: models: fix javadoc formatting issues

in-toto · Sep 12, 2018 · 1b23f84 · 1b23f84
1 parent f09c681
commit 1b23f84
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/main/java/io/github/in_toto/models/Link.java b/src/main/java/io/github/in_toto/models/Link.java
@@ -31,7 +31,7 @@ public class Link extends Metablock<LinkSignable>
      * @param byproducts A HashMap containing the byproduct triplet
      * stdin/stdout/retval.
      *
-     * @see io.in_toto.models.Artifact
+     * @see io.github.in_toto.models.Artifact
      */
     public Link(HashMap<String, ArtifactHash> materials,
             HashMap<String, ArtifactHash> products, String name,
@@ -55,7 +55,7 @@ public void dump() {
     /**
      * get full link name, including keyid bytes in the form of
      *
-     *  <stepname>.<keyid_bytes>.link
+     *  {@literal <stepname>.<keyid_bytes>.link }
      *
      *  This method will always use the keyid of the first signature in the
      *  metadata.

diff --git a/src/main/java/io/github/in_toto/models/Metablock.java b/src/main/java/io/github/in_toto/models/Metablock.java
@@ -63,6 +63,8 @@ public void dump(String filename) {
      * Serialize the current metadata into a writer
      *
      * @param writer the target writer
+     *
+     * @throws java.io.IOException if unable to write to the passed writer.
      */
     public void dump(Writer writer)
         throws IOException {