1
0
mirror of https://e.coding.net/circlecloud/YumCore.git synced 2024-11-14 00:28:53 +00:00

doc: 调整Javadoc文档

Signed-off-by: 502647092 <admin@yumc.pw>
This commit is contained in:
502647092 2016-11-16 20:25:56 +08:00
parent 05c1a2b4f1
commit aa6577db3b
5 changed files with 24 additions and 13 deletions

View File

@ -42,6 +42,8 @@ public class P {
}
/**
* @param <FC>
* 配置源类型
* @return 获得插件配置文件
*/
@SuppressWarnings("unchecked")
@ -78,6 +80,8 @@ public class P {
}
/**
* @param <PI>
* 插件源类型
* @return 获得插件
*/
@SuppressWarnings("unchecked")

View File

@ -270,6 +270,7 @@ public class CommandManager implements TabExecutor {
*
* @param clazzs
* 子命令处理类
* @return {@link CommandManager}
*/
public CommandManager register(Executor... clazzs) {
for (Executor clazz : clazzs) {
@ -343,6 +344,7 @@ public class CommandManager implements TabExecutor {
*
* @param commandErrorHanlder
* 命令错误处理器
* @return {@link CommandManager}
*/
public CommandManager setCommandErrorHanlder(ErrorHanlder commandErrorHanlder) {
this.commandErrorHanlder = commandErrorHanlder;
@ -354,6 +356,7 @@ public class CommandManager implements TabExecutor {
*
* @param helpGenerator
* 帮助生成器
* @return {@link CommandManager}
*/
public CommandManager setHelpGenerator(HelpGenerator helpGenerator) {
help.setHelpGenerator(helpGenerator);
@ -365,6 +368,7 @@ public class CommandManager implements TabExecutor {
*
* @param helpParse
* 帮助解析器
* @return {@link CommandManager}
*/
public CommandManager setHelpParse(HelpParse helpParse) {
if (help.getHelpGenerator() instanceof CommandHelp.DefaultHelpGenerator) {

View File

@ -67,16 +67,18 @@ public class LogKit implements Runnable {
* 日志
*/
public void console(final String s) {
sender(Bukkit.getConsoleSender(), s);
send(Bukkit.getConsoleSender(), s);
}
/**
* 添加日志
*
*
* @param sender
* 接受者
* @param s
* 日志
*/
public void sender(final CommandSender sender, final String s) {
public void send(final CommandSender sender, final String s) {
Log.toSender(sender, s);
log(ChatColor.stripColor(s));
}

View File

@ -8,8 +8,8 @@ import java.util.Map;
/**
* A wrapper for an {@link Object} or {@link Class} upon which reflective calls can be made.
* <p>
* An example of using <code>Reflect</code> is <code>
*
* An example of using <code>Reflect</code> is
*
* <pre>
* // Static import all reflection methods to decrease verbosity
* import static org.joor.Reflect.*;
@ -21,7 +21,8 @@ import java.util.Map;
* // Invoke methods using the call() method:
* .call("toString")
* // Retrieve the wrapped object
*
* </pre>
*
* @author Lukas Eder
*/
public class Reflect {
@ -274,6 +275,8 @@ public class Reflect {
/**
* Create a proxy for the wrapped object allowing to typesafely invoke methods on it using a custom interface
*
* @param <P>
* 代理类型
* @param proxyType
* The interface type that is implemented by the proxy
* @return A proxy for the wrapped object
@ -557,7 +560,9 @@ public class Reflect {
* value from an instance member field.
* <p>
* If you want to "navigate" to a wrapped version of the field, use {@link #field(String)} instead.
*
*
* @param <T>
* A convenience generic parameter for automatic unsafe casting
* @param name
* The field name
* @return The field value
@ -615,9 +620,6 @@ public class Reflect {
}
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return object.toString();
@ -625,7 +627,8 @@ public class Reflect {
/**
* Get the type of the wrapped object.
*
*
* @return 类类型
* @see Object#getClass()
*/
public Class<?> type() {

View File

@ -318,10 +318,8 @@ public class Tellraw {
* <li>消息串的文本.</li>
* </ol>
* 这个方法会丢失点击操作和悬浮操作 所以仅用于最后的手段
* </p>
* <p>
* 颜色和格式可以从返回的字符串中删除 通过{@link ChatColor#stripColor(String)}.
* </p>
*
* @return 发送给老版本客户端以及控制台
*/