ZenDoc
Link to zendoc
The @ZenDoc
annotation allows developers to provide additional information to the /ct dumpZS
command.
More specifically, it will look like this:
Example
Link to example
CraftTweaker Test Project ZenDoc
java Copy@ZenClass(value = "crafttweaker.tests.zenDoc")
@ZenRegister
public class ZenDocWiki {
@ZenMethod
@ZenDoc("This prints a warning")
public static void print() {
CraftTweakerAPI.logWarning("Print invoked!");
}
}
What methods can be annotated || Additional Info
Link to what-methods-can-be-annotated--additional-info
- You can annotate all methods, static and nonstatic.
- Currently, this will only affect the generated HTML file when running
/ct dumpzs
. - This annotation takes one String as value that is the additional information that should be printed.