Docblock for r_string methods.

xray-forge · Dec 9, 2023 · 8ad0018 · 8ad0018
1 parent 958eee0
commit 8ad0018
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/types/xr_lib/xr_ini.d.ts b/types/xr_lib/xr_ini.d.ts
@@ -76,8 +76,18 @@ declare module "xray16" {
 
     public r_string_wq(section: string, field: string): string;
 
+    /**
+     * @param section - ini file section
+     * @param field - ini section field
+     * @returns if quoted, parsed string data inside quotes including spaces, else is same data as with r_string
+     */
     public r_string_wb(section: string, field: string): string;
 
+    /**
+     * @param section - ini file section
+     * @param field - ini section field
+     * @returns raw string from ltx file without spaces in it
+     */
     public r_string(section: string, field: string): string;
 
     /**