From f8ea0bf972cdce5262fe73c58c73ea64a4c68baf Mon Sep 17 00:00:00 2001
From: rswindell <>
Date: Thu, 15 Jun 2006 03:20:00 +0000
Subject: [PATCH] JSDOC fixes.
---
src/sbbs3/js_bbs.cpp | 2 +-
src/sbbs3/js_internal.c | 4 ++--
src/sbbs3/js_socket.c | 6 ++++--
src/sbbs3/js_system.c | 2 +-
src/sbbs3/main.cpp | 2 +-
5 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/src/sbbs3/js_bbs.cpp b/src/sbbs3/js_bbs.cpp
index be9669e902..83951b2587 100644
--- a/src/sbbs3/js_bbs.cpp
+++ b/src/sbbs3/js_bbs.cpp
@@ -885,7 +885,7 @@ static jsSyncPropertySpec js_bbs_properties[] = {
{ "batch_upload_total",BBS_PROP_BATCH_UPLOAD_TOTAL,PROP_READONLY ,310},
{ "batch_dnload_total",BBS_PROP_BATCH_DNLOAD_TOTAL,PROP_READONLY ,310},
- { "command_str" ,BBS_PROP_COMMAND_STR ,JSPROP_ENUMERATE, 313}, /* 3.13b */
+ { "command_str" ,BBS_PROP_COMMAND_STR ,JSPROP_ENUMERATE, 314},
{0}
};
diff --git a/src/sbbs3/js_internal.c b/src/sbbs3/js_internal.c
index bd34652a2a..a927e1c77e 100644
--- a/src/sbbs3/js_internal.c
+++ b/src/sbbs3/js_internal.c
@@ -180,7 +180,7 @@ static jsSyncPropertySpec js_properties[] = {
{ "bytes", PROP_BYTES, PROP_FLAGS, 311 },
{ "max_bytes", PROP_MAXBYTES, JSPROP_ENUMERATE, 311 },
#endif
- { "global", PROP_GLOBAL, PROP_FLAGS, 313 },
+ { "global", PROP_GLOBAL, PROP_FLAGS, 314 },
{0}
};
@@ -393,7 +393,7 @@ static jsSyncMethodSpec js_functions[] = {
},
{"get_parent", js_get_parent, 1, JSTYPE_OBJECT, JSDOCSTR("object")
,JSDOCSTR("return the parent of the specified object")
- ,313
+ ,314
},
{0}
};
diff --git a/src/sbbs3/js_socket.c b/src/sbbs3/js_socket.c
index 4817314b55..98eec89504 100644
--- a/src/sbbs3/js_socket.c
+++ b/src/sbbs3/js_socket.c
@@ -1409,8 +1409,10 @@ js_socket_constructor(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsv
#ifdef BUILD_JSDOCS
js_DescribeSyncObject(cx,obj,"Class used for TCP/IP socket communications",310);
js_DescribeSyncConstructor(cx,obj,"To create a new Socket object: "
- "<tt>load('sockdefs.js'); var s = new Socket(<i>type</i>)</tt><br>"
- "where <i>type</i> = <tt>SOCK_STREAM</tt> for TCP (default) or <tt>SOCK_DGRAM</tt> for UDP");
+ "<tt>load('sockdefs.js'); var s = new Socket(<i>type</i>, <i>protocol</i>)</tt><br>"
+ "where <i>type</i> = <tt>SOCK_STREAM</tt> for TCP (default) or <tt>SOCK_DGRAM</tt> for UDP<br>"
+ "and <i>protocol</i> (optional) = the name of the protocol or service the socket is to be used for"
+ );
js_CreateArrayOfStrings(cx, obj, "_property_desc_list", socket_prop_desc, JSPROP_READONLY);
#endif
diff --git a/src/sbbs3/js_system.c b/src/sbbs3/js_system.c
index 518dbabd30..91b1ddff3f 100644
--- a/src/sbbs3/js_system.c
+++ b/src/sbbs3/js_system.c
@@ -406,7 +406,7 @@ static jsSyncPropertySpec js_system_properties[] = {
/* clock access */
{ "clock_ticks", SYS_PROP_CLOCK ,SYSOBJ_FLAGS, 311 },
{ "clock_ticks_per_second", SYS_PROP_CLOCK_PER_SEC ,SYSOBJ_FLAGS, 311 },
- { "timer", SYS_PROP_TIMER ,SYSOBJ_FLAGS, 313 },
+ { "timer", SYS_PROP_TIMER ,SYSOBJ_FLAGS, 314 },
/* last */
{ "local_host_name", SYS_PROP_LOCAL_HOSTNAME ,SYSOBJ_FLAGS, 311 },
diff --git a/src/sbbs3/main.cpp b/src/sbbs3/main.cpp
index db1e9d929d..90007b2e2c 100644
--- a/src/sbbs3/main.cpp
+++ b/src/sbbs3/main.cpp
@@ -807,7 +807,7 @@ static jsSyncMethodSpec js_global_functions[] = {
},
{"write_raw", js_write_raw, 0, JSTYPE_VOID, JSDOCSTR("value [,value]")
,JSDOCSTR("send a stream of bytes (possibly containing NULLs or special control code sequences) to the server output")
- ,313
+ ,314
},
{"print", js_writeln, 0, JSTYPE_ALIAS },
{"writeln", js_writeln, 0, JSTYPE_VOID, JSDOCSTR("value [,value]")
--
GitLab