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

diff --git a/src/main/java/net/pterodactylus/sone/text/LinkPart.java b/src/main/java/net/pterodactylus/sone/text/LinkPart.java
index d911bbd..2e7d331 100644
--- a/src/main/java/net/pterodactylus/sone/text/LinkPart.java
+++ b/src/main/java/net/pterodactylus/sone/text/LinkPart.java
@@ -1,5 +1,5 @@
 /*
- * Sone - LinkPart.java - Copyright © 2011 David Roden
+ * Sone - LinkPart.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,20 +18,45 @@
 package net.pterodactylus.sone.text;
 
 /**
- * TODO
+ * {@link Part} implementation that can hold a link. A link contains of three
+ * attributes: the link itself, the text that is shown instead of the link, and
+ * an explanatory text that can be displayed e.g. as a tooltip.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public class LinkPart implements Part {
 
+	/** The link of this part. */
 	private final String link;
+
+	/** The text of this part. */
 	private final String text;
+
+	/** The title of this part. */
 	private final String title;
 
+	/**
+	 * Creates a new link part.
+	 *
+	 * @param link
+	 *            The link of the link part
+	 * @param text
+	 *            The text of the link part
+	 */
 	public LinkPart(String link, String text) {
 		this(link, text, text);
 	}
 
+	/**
+	 * Creates a new link part.
+	 *
+	 * @param link
+	 *            The link of the link part
+	 * @param text
+	 *            The text of the link part
+	 * @param title
+	 *            The title of the link part
+	 */
 	public LinkPart(String link, String text, String title) {
 		this.link = link;
 		this.text = text;
@@ -42,16 +67,36 @@ public class LinkPart implements Part {
 	// ACCESSORS
 	//
 
+	/**
+	 * Returns the link of this part.
+	 *
+	 * @return The link of this part
+	 */
 	public String getLink() {
 		return link;
 	}
 
-	public String getText() {
-		return text;
-	}
-
+	/**
+	 * Returns the title of this part.
+	 *
+	 * @return The title of this part
+	 */
 	public String getTitle() {
 		return title;
 	}
 
+	//
+	// PART METHODS
+	//
+
+	/**
+	 * Returns the text of this part.
+	 *
+	 * @return The text of this part
+	 */
+	@Override
+	public String getText() {
+		return text;
+	}
+
 }