From adde167a9135c7befe2979cdf6295e13b89bdec1 Mon Sep 17 00:00:00 2001 From: Synthasmagoria Date: Thu, 28 May 2026 11:07:29 +0200 Subject: [PATCH] JsDoc comments --- main.odin | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/main.odin b/main.odin index 02c0e1a..9430b74 100644 --- a/main.odin +++ b/main.odin @@ -181,13 +181,24 @@ gml_write_enums :: proc(gml: ^strings.Builder, enums: [dynamic]GmlEnum) { } fmt.sbprint(gml, "];\n\n", sep = "") - fmt.sbprint(gml, "function ", ENUM_GET_NAME_FUNCTION, "(index) {return ", ENUM_NAMES_GLOBAL, "[index];}\n", sep = "") + fmt.sbprint(gml, "///@param {Real} index\n") + fmt.sbprint(gml, "///@return {String}\n") + fmt.sbprint(gml, "function ", ENUM_GET_NAME_FUNCTION, "(index) {return ", ENUM_NAMES_GLOBAL, "[index];}\n\n", sep = "") - fmt.sbprint(gml, "function ", ENUM_GET_MEMBER_NAME_FUNCTION, "(index, member) {return ", ENUM_MEMBER_NAMES_GLOBAL, "[index][member];}\n", sep = "") + fmt.sbprint(gml, "///@param {Real} index\n") + fmt.sbprint(gml, "///@param {Real} member\n") + fmt.sbprint(gml, "///@return {String}\n") + fmt.sbprint(gml, "function ", ENUM_GET_MEMBER_NAME_FUNCTION, "(index, member) {return ", ENUM_MEMBER_NAMES_GLOBAL, "[index][member];}\n\n", sep = "") - fmt.sbprint(gml, "function ", ENUM_GET_MEMBER_NAMES_FUNCTION, "(index) {return ", ENUM_MEMBER_NAMES_GLOBAL, "[index];}", sep = "") + fmt.sbprint(gml, "///@param {Real} index\n") + fmt.sbprint(gml, "///@return {String}\n") + fmt.sbprint(gml, "function ", ENUM_GET_MEMBER_NAMES_FUNCTION, "(index) {return ", ENUM_MEMBER_NAMES_GLOBAL, "[index];}\n\n", sep = "") + fmt.sbprint(gml, "///@param {Real} index\n") + fmt.sbprint(gml, "///@param {Real} member\n") + fmt.sbprint(gml, "///@return {String}\n") fmt.sbprint(gml, "function ", ENUM_GET_MEMBER_NAME_FULL_FUNCTION, "(index, member) {\n", sep = "") - fmt.sbprint(gml, TAB, "return $\"{", ENUM_NAMES_GLOBAL, "[index]}.{" + ENUM_MEMBER_NAMES_GLOBAL, "[index][member]}\";\n", sep = "") + fmt.sbprint(gml, TAB, "return $\"{", ENUM_NAMES_GLOBAL, "[index]}.{" + ENUM_MEMBER_NAMES_GLOBAL, "[index][member]}\";\n\n", sep = "") fmt.sbprint(gml, "}\n\n", sep = "") } +