Thingo
This commit is contained in:
12
src/main/java/com/aranroig/docs/ParamDoc.java
Normal file
12
src/main/java/com/aranroig/docs/ParamDoc.java
Normal file
@@ -0,0 +1,12 @@
|
||||
package com.aranroig.docs;
|
||||
|
||||
/**
|
||||
* One parameter of a documented Lua function.
|
||||
*
|
||||
* @param name parameter name as written in the signature, e.g. {@code "block"}
|
||||
* @param type short type name shown to the user, e.g. {@code "string"} or {@code "number"}
|
||||
* @param optional whether the parameter may be omitted
|
||||
* @param description what the parameter means
|
||||
*/
|
||||
public record ParamDoc(String name, String type, boolean optional, String description) {
|
||||
}
|
||||
Reference in New Issue
Block a user