PandacubeFr/BungeeCord
1
0
Fork 0
Code Releases Activity

Merge pull request #773 from YoshiGenius/patch-1

Browse Source 
Fix javadoc - spelling and details
This commit is contained in:
thinkofdeath 2014-01-01 15:16:46 -08:00
commit 0d7cd78901
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java
View File

@ -29,7 +29,7 @@ public class ComponentBuilder
private List<BaseComponent> parts = new ArrayList<>(); private List<BaseComponent> parts = new ArrayList<>();
/** /**
* Creates a componentBuilder with the given text as the * Creates a ComponentBuilder with the given text as the
* first part. * first part.
* *
* @param text the first text element * @param text the first text element
@ -80,7 +80,7 @@ public class ComponentBuilder
} }
/** /**
* Sets whether the current part is italic * Sets whether the current part is italic.
* *
* @param italic whether this part is italic * @param italic whether this part is italic
* @return this ComponentBuilder for chaining * @return this ComponentBuilder for chaining
@ -92,7 +92,7 @@ public class ComponentBuilder
} }
/** /**
* Sets whether the current part is underlined * Sets whether the current part is underlined.
* *
* @param underlined whether this part is underlined * @param underlined whether this part is underlined
* @return this ComponentBuilder for chaining * @return this ComponentBuilder for chaining
@ -104,7 +104,7 @@ public class ComponentBuilder
} }
/** /**
* Sets whether the current part is strikethrough * Sets whether the current part is strikethrough.
* *
* @param strikethrough whether this part is strikethrough * @param strikethrough whether this part is strikethrough
* @return this ComponentBuilder for chaining * @return this ComponentBuilder for chaining
@ -116,7 +116,7 @@ public class ComponentBuilder
} }
/** /**
* Sets whether the current pat is obfuscated * Sets whether the current part is obfuscated.
* *
* @param obfuscated whether this part is obfuscated * @param obfuscated whether this part is obfuscated
* @return this ComponentBuilder for chaining * @return this ComponentBuilder for chaining
@ -129,8 +129,9 @@ public class ComponentBuilder
/** /**
* Sets the click event for the current part. * Sets the click event for the current part.
* @param clickEvent *
* @return * @param clickEvent the click event
* @return this ComponentBuilder for chaining
*/ */
public ComponentBuilder event(ClickEvent clickEvent) public ComponentBuilder event(ClickEvent clickEvent)
{ {
@ -138,6 +139,12 @@ public class ComponentBuilder
return this; return this;
} }
/**
* Sets the hover event for the current part.
*
* @param hoverEvent the hover event
* @return this ComponentBuilder for chaining
*/
public ComponentBuilder event(HoverEvent hoverEvent) public ComponentBuilder event(HoverEvent hoverEvent)
{ {
current.setHoverEvent( hoverEvent ); current.setHoverEvent( hoverEvent );
@ -146,7 +153,8 @@ public class ComponentBuilder
/** /**
* Returns the components needed to display the message * Returns the components needed to display the message
* created by this builder * created by this builder.
*
* @return the created components * @return the created components
*/ */
public BaseComponent[] create() public BaseComponent[] create()