From 2c34484ea2d04aa21265296f090268fb664c72f8 Mon Sep 17 00:00:00 2001
From: deuce <>
Date: Sat, 12 Nov 2011 02:39:52 +0000
Subject: [PATCH] Document the properties.
---
src/sbbs3/js_uifc.c | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/src/sbbs3/js_uifc.c b/src/sbbs3/js_uifc.c
index 735ba2d033..a49150b6d9 100644
--- a/src/sbbs3/js_uifc.c
+++ b/src/sbbs3/js_uifc.c
@@ -207,6 +207,25 @@ static jsSyncPropertySpec js_properties[] = {
{0}
};
+#ifdef BUILD_JSDOCS
+static char* uifc_prop_desc[] = {
+ "uifc has been initialized"
+ ,"current mode bits (see uifcdefs.js)"
+ ,"a change has occured in an input call. You are expected to set this to false before calling the input if you care about it."
+ ,"save buffer depth (advanced)"
+ ,"current screen length"
+ ,"current screen width"
+ ,"when WIN_FIXEDHEIGHT is set, specifies the hight used by a list method"
+ ,"delay before a single ESC char is parsed and assumed to not be an ANSI sequence (advanced)"
+ ,"text that will be displayed if F1 is pressed"
+ ,"background colour"
+ ,"frame colour"
+ ,"text colour"
+ ,"inverse colour"
+ ,"lightbar colour"
+};
+#endif
+
/* Convenience functions */
static uifcapi_t* get_uifc(JSContext *cx, JSObject *obj)
{
@@ -590,6 +609,11 @@ JSObject* js_CreateUifcObject(JSContext* cx, JSObject* parent)
if(!JS_SetPrivate(cx, obj, api)) /* Store a pointer to uifcapi_t */
return(NULL);
+#ifdef BUILD_JSDOCS
+ js_DescribeSyncObject(cx,obj,"User InterFaCe object - used for jsexec menus" ,310);
+ js_CreateArrayOfStrings(cx, obj, "_property_desc_list", uifc_prop_desc, JSPROP_READONLY);
+#endif
+
return(obj);
}
--
GitLab