populate docstrings and minor tweaks

jscomp/Makefile

@@ -660,7 +660,7 @@ DOCS_SOURCES+=$(shell ls others/*.ml*)
 docs: ../odoc_gen/generator.cmxs
 	make -C ../lib bsppx.exe
 	node ../scripts/doc_gen.js
-# ocamldoc.opt -nostdlib -I stdlib -g ../odoc_gen/generator.cmxs -charset utf-8 -css-style ../../odoc_gen/style.css -sort -ppx bin/bsppx.exe -I others -I runtime -d ../docs/api $(DOCS_SOURCES)
+
 
 top: bs_hash.cma ext.cma bsb.cma
 repl: top

jscomp/core/bs_conditional_initial.ml

@@ -25,7 +25,7 @@
 
 let setup_env () = 
 #if BS_DEBUG then    
-    Js_config.set_debug_file "gpr_2250_test.ml";
+    Js_config.set_debug_file "gpr_2487.ml";
 #end       
   Lexer.replace_directive_bool "BS" true;
   Lexer.replace_directive_string "BS_VERSION"  Bs_version.version

jscomp/others/.depend

@@ -21,7 +21,6 @@ bs_internalAVLset.cmj : bs_SortArray.cmj bs_Dict.cmj bs_Array.cmj \
     bs_internalAVLset.cmi
 bs_internalAVLtree.cmj : bs_SortArray.cmj bs_Dict.cmj bs_Array.cmj \
     bs_internalAVLtree.cmi
-bs_Queue.cmj : bs_Array.cmj bs_Queue.cmi
 bs_List.cmj : bs_Array.cmj bs_List.cmi
 bs_SortArray.cmj : bs_SortArrayString.cmj bs_SortArrayInt.cmj bs_Array.cmj \
     bs_SortArray.cmi
@@ -80,7 +79,8 @@ bs_SetInt.cmj : bs_internalSetInt.cmj bs_internalAVLset.cmj bs_Array.cmj \
     bs_SetInt.cmi
 bs_SetString.cmj : bs_internalSetString.cmj bs_internalAVLset.cmj \
     bs_Array.cmj bs_SetString.cmi
-bs_Stack.cmj : bs_Stack.cmi
+bs_MutableStack.cmj : bs_MutableStack.cmi
+bs_MutableQueue.cmj : bs_Array.cmj bs_MutableQueue.cmi
 node_child_process.cmj : node.cmj
 js_boolean.cmj : js_boolean.cmi
 js_math.cmj :
@@ -106,7 +106,6 @@ js_mapperRt.cmi :
 bs_Array.cmi :
 bs_internalAVLset.cmi : bs_Dict.cmi
 bs_internalAVLtree.cmi : bs_Dict.cmi
-bs_Queue.cmi :
 bs_List.cmi :
 bs_SortArray.cmi : bs_SortArrayString.cmi bs_SortArrayInt.cmi
 bs_SortArrayInt.cmi :
@@ -133,7 +132,8 @@ bs_MutableMapInt.cmi :
 bs_MutableMapString.cmi :
 bs_SetInt.cmi :
 bs_SetString.cmi :
-bs_Stack.cmi :
+bs_MutableStack.cmi :
+bs_MutableQueue.cmi :
 js_boolean.cmi :
 js_dict.cmi :
 js_cast.cmi :

jscomp/others/Makefile

@@ -14,7 +14,6 @@ SOURCE_LIST= node_path node_fs node_process dict node_module js_array js_string
 	bs_internalAVLset\
 	bs_internalAVLtree\
 	bs_internalMutableAVL\
-	bs_Queue\
 	bs_List\
 	bs_SortArray\
 	bs_SortArrayInt\
@@ -47,7 +46,8 @@ SOURCE_LIST= node_path node_fs node_process dict node_module js_array js_string
 	bs_internalSetString\
 	bs_SetInt\
 	bs_SetString\
-	bs_Stack\
+	bs_MutableStack\
+	bs_MutableQueue\
 	node_child_process \
 	js_boolean js_math\
 	js_dict js_date js_global js_cast js_promise\

jscomp/others/bs.ml

@@ -23,19 +23,62 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 
 
+(** A stdlib shipped with BuckleScript *)
 
-(**/*)
-(**/*)
+(** {!Bs.Dict}
 
+    Provide utiliites to create identified comparators or hashes for 
+    data structures used below. 
+
+    It create a unique identifer per module of
+    functions so that different data structures with slightly different 
+    comparison functions won't mix
+*)
 module Dict = Bs_Dict
+
+(** {!Bs.Array}
+
+    Utililites for Array functions 
+*)
 module Array = Bs_Array
-module MutableQueue = Bs_Queue
+
+(** {!Bs.SortArray}
+
+    The toplevel provides some generic sort related utililties.
+
+    It also has two specialized inner modules
+    {!Bs.SortArray.Int} and {!Bs.SortArray.String}
+*)
+module SortArray = Bs_SortArray
+
+(** {!Bs.MutableQueue}
+
+    An FIFO(first in first out) queue data structure
+*)
+module MutableQueue = Bs_MutableQueue
+
+(** {!Bs.MutableStack}
+
+    An FILO(first in last out) stack data structure
+*)
+module MutableStack = Bs_MutableStack 
+
+(** {!Bs.List}
+
+    Utilities for List data type
+*)
 module List = Bs_List
-module MutableStack = Bs_Stack
+
+(** {!Bs.Range}
+
+    Utilities for a closed range [(from, start)]
+*)
 module Range = Bs_Range
 
 (** {!Bs.Set}
+
     The toplevel provides generic immutable set operations.
+
     It also has three specialized inner modules
     {!Bs.Set.Int} and {!Bs.Set.String}
     {!Bs.Set.Dict}: This module separate date from function
@@ -46,7 +89,9 @@ module Set = Bs_Set
 
 
 (** {!Bs.Map},
+
     The toplevel provides generic immutable map operations.
+
     It also has three specialized inner modules
     {!Bs.Map.Int} and {!Bs.Map.String}
     {!Bs.Map.Dict}: This module separate date from function
@@ -56,14 +101,18 @@ module Map = Bs_Map
 
 
 (** {!Bs.MutableSet}
+
     The toplevel provides generic mutable set operations.
+
     It also has two specialized inner modules
     {!Bs.MutableSet.Int} and {!Bs.MutableSet.String}
 *)
 module MutableSet = Bs_MutableSet
 
 (** {!Bs.MutableMap}
+
     The toplevel provides generic mutable map operations.
+
     It also has two specialized inner modules
     {!Bs.MutableMap.Int} and {!Bs.MutableMap.String}
 
@@ -72,27 +121,25 @@ module MutableMap = Bs_MutableMap
 
 
 (** {!Bs.HashSet}
+
     The toplevel provides generic mutable hash set operations.
+
     It also has two specialized inner modules
     {!Bs.HashSet.Int} and {!Bs.HashSet.String}
 *)
 module HashSet = Bs_HashSet
 
 
 (** {!Bs.HashMap}
+
     The toplevel provides generic mutable hash map operations.
+
     It also has two specialized inner modules
     {!Bs.HashMap.Int} and {!Bs.HashMap.String}
 *)
 module HashMap = Bs_HashMap
 
 
-(** {!Bs.SortArray}
-    The toplevel provides some generic sort related utililties.
-    It also has two specialized inner modules
-    {!Bs.SortArray.Int} and {!Bs.SortArray.String}
-*)
-module SortArray = Bs_SortArray