X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ftext%2FFreenetLinkPart.java;h=b8fd2402862da78d9a641e21a8dc2f5cda49b9d2;hp=2efb3806dfe8aee9b860449ba99564e926ee3598;hb=419098bcd6215125408b29e60bd888e60979d37b;hpb=ab7fada54ed08b0a8d9ce9c606cbea29c3c3f819

diff --git a/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java b/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java
index 2efb380..b8fd240 100644
--- a/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java
+++ b/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java
@@ -1,5 +1,5 @@
 /*
- * Sone - FreenetLinkPart.java - Copyright © 2011 David Roden
+ * Sone - FreenetLinkPart.java - Copyright © 2011–2015 David Roden
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,23 +18,57 @@
 package net.pterodactylus.sone.text;
 
 /**
- * TODO
+ * {@link LinkPart} implementation that stores an additional attribute: if the
+ * link is an SSK or USK link and the post was created by an identity that owns
+ * the keyspace in question.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public class FreenetLinkPart extends LinkPart {
 
+	/** Whether the link is trusted. */
 	private final boolean trusted;
 
+	/**
+	 * Creates a new freenet link part.
+	 *
+	 * @param link
+	 *            The link of the part
+	 * @param text
+	 *            The text of the part
+	 * @param trusted
+	 *            {@code true} if the link is trusted, {@code false} otherwise
+	 */
 	public FreenetLinkPart(String link, String text, boolean trusted) {
 		this(link, text, text, trusted);
 	}
 
+	/**
+	 * Creates a new freenet link part.
+	 *
+	 * @param link
+	 *            The link of the part
+	 * @param text
+	 *            The text of the part
+	 * @param title
+	 *            The title of the part
+	 * @param trusted
+	 *            {@code true} if the link is trusted, {@code false} otherwise
+	 */
 	public FreenetLinkPart(String link, String text, String title, boolean trusted) {
 		super(link, text, title);
 		this.trusted = trusted;
 	}
 
+	//
+	// ACCESSORS
+	//
+
+	/**
+	 * Returns whether the link is trusted.
+	 *
+	 * @return {@code true} if the link is trusted, {@code false} otherwise
+	 */
 	public boolean isTrusted() {
 		return trusted;
 	}