changeset 684:b346e4699e55

Add more comment for JS binding
author Thinker K.F. Li <thinker@branda.to>
date Sat, 07 Aug 2010 19:33:42 +0800
parents 7685c57e29d0
children 7bb126d42282
files Doxyfile nodejs/coord.cc nodejs/image_ldr.cc nodejs/mbfly_njs.cc nodejs/paints.cc nodejs/shapes.cc
diffstat 6 files changed, 27 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/Doxyfile	Sat Aug 07 18:27:53 2010 +0800
+++ b/Doxyfile	Sat Aug 07 19:33:42 2010 +0800
@@ -534,7 +534,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = src tools include dox README.h COPYING.h
+INPUT                  = src tools include dox README.h COPYING.h nodejs
 
 # This tag can be used to specify the character encoding of the source files 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
--- a/nodejs/coord.cc	Sat Aug 07 18:27:53 2010 +0800
+++ b/nodejs/coord.cc	Sat Aug 07 19:33:42 2010 +0800
@@ -16,6 +16,11 @@
 
 using namespace v8;
 
+/*! \defgroup xnjsmb_coord JS binding for coord objects.
+ * \ingroup xnjsmb
+ *
+ * @{
+ */
 static void
 xnjsmb_coord_mod(Handle<Object> self, coord_t *coord) {
     Persistent<Object> *self_hdl;
@@ -80,6 +85,8 @@
 
 #include "coord-inc.h"
 
+/*! \brief This function used by \ref xnjsmb_mb_rt to wrap coord object.
+ */
 Handle<Value> export_xnjsmb_auto_coord_new(coord_t *coord) {
     xnjsmb_auto_coord_new(coord);
 }
@@ -110,3 +117,5 @@
 
     SET(js_rt, "root", obj);
 }
+
+/* @} */
--- a/nodejs/image_ldr.cc	Sat Aug 07 18:27:53 2010 +0800
+++ b/nodejs/image_ldr.cc	Sat Aug 07 19:33:42 2010 +0800
@@ -15,7 +15,8 @@
 #define ASSERT(x)
 #endif
 
-/*! \defgroup img_ldr_js Javascript binding for image loader.
+/*! \defgroup xnjsmb_img_ldr_js Javascript binding for image loader.
+ * \ingroup xnjsmb
  *
  * @{
  */
--- a/nodejs/mbfly_njs.cc	Sat Aug 07 18:27:53 2010 +0800
+++ b/nodejs/mbfly_njs.cc	Sat Aug 07 19:33:42 2010 +0800
@@ -10,6 +10,11 @@
 
 using namespace v8;
 
+/*! \defgroup xnjsmb_mb_rt JS binding for MB runtime.
+ * \ingroup xnjsmb
+ *
+ * @{
+ */
 static coord_t *
 xnjsmb_coord_new(njs_runtime_t *rt, coord_t *parent, const char **err) {
     coord_t *coord;
@@ -132,3 +137,5 @@
     target->Set(String::New("mb_rt"),
 		xnjsmb_auto_mb_rt_temp->GetFunction());    
 }
+
+/* @} */
--- a/nodejs/paints.cc	Sat Aug 07 18:27:53 2010 +0800
+++ b/nodejs/paints.cc	Sat Aug 07 19:33:42 2010 +0800
@@ -12,6 +12,11 @@
 #define ASSERT(x)
 #endif
 
+/*! \defgroup xnjsmb_paints JS binding for paints
+ * \ingroup xnjsmb
+ *
+ * @{
+ */
 
 /*! \brief Fill a shape with the paint.
  */
@@ -287,3 +292,5 @@
     SET(rt_proto_temp, "paint_color_new", xnjsmb_paint_color_new_temp);
     SET(rt_proto_temp, "paint_image_new", xnjsmb_paint_image_new_temp);
 }
+
+/* @} */
--- a/nodejs/shapes.cc	Sat Aug 07 18:27:53 2010 +0800
+++ b/nodejs/shapes.cc	Sat Aug 07 19:33:42 2010 +0800
@@ -13,7 +13,7 @@
 
 using namespace v8;
 
-/*! \defgroup xnjsmb_shapes Implement binding of shapes.
+/*! \defgroup xnjsmb_shapes JS binding for shapes.
  * \ingroup xnjsmb
  *
  * @{