summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2012-11-03 14:37:42 +0000
committerVincent Sanders <vince@kyllikki.org>2012-11-03 14:37:42 +0000
commitfd1bad30d8603c1dd487034243600901e0dffb23 (patch)
tree244b3b077f49307718540bf51e14cf309c15ae4b /doc
parentb24bb6c442566ead09e9e7675aa5631b1eb618dc (diff)
downloadnsgenbind-fd1bad30d8603c1dd487034243600901e0dffb23.tar.gz
nsgenbind-fd1bad30d8603c1dd487034243600901e0dffb23.tar.bz2
fix finaliser api content output
Diffstat (limited to 'doc')
-rw-r--r--doc/example.bnd4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/example.bnd b/doc/example.bnd
index dfd0bb5..a57d970 100644
--- a/doc/example.bnd
+++ b/doc/example.bnd
@@ -224,6 +224,10 @@ api finalise %{
* Prototype is:
* JSBool jsclass_resolve(JSContext *cx, JSObject *obj, jsval id, uintN flags, JSObject **objp)
*
+ * By default returns JS_TRUE implying that *objp has been updated
+ *
+ * The minimal implementation would be "*objp = NULL;" but is
+ * equivalent to simply omitting this directive and using the defaul stub.
*/
api resolve %{
%}