Changeset 383 for cpp/frams

Timestamp:

05/22/15 04:20:22 (10 years ago)

Author:

sz

Message:

Added more examples in Vector and Dictionary documentation.

File:

• cpp/frams/vm/classes/collectionobj.cpp (modified) (2 diffs)

cpp/frams/vm/classes/collectionobj.cpp

@@ -17 +17 @@
 {"Vector",1,13,"Vector","Vector is 1-dimensional array, indexed by integer value (starting from 0). "
  "Multidimensional arrays can be simulated by putting other Vector objects into the Vector.\n"
- "Example:\nvar v=Vector.new();\nv.add(123); v.add(\"string\");",},
+ "Examples:\n"
+ "var v1=Vector.new(); v1.add(123); v1.add(\"string\");\n"
+ "var v2=[123,\"string\"];// short way of doing the same (square brackets create a vector)\n"
+ "var v3=[[1,2,3],[4,5],[6]];// simulate a 2d array\n"
+ "for(var element in v3) Simulator.print(element);//Vector supports enumeration"
+},
 {"clear",0,PARAM_NOSTATIC,"clear data","p()",PROCEDURE(p_clear),},
 {"size",0,PARAM_READONLY | PARAM_NOSTATIC,"element count","d",GETONLY(size),},
 {"remove",0,PARAM_NOSTATIC,"remove at position","p(d position)",PROCEDURE(p_remove),},
-{"get",0,PARAM_NOSTATIC,"get value at position","p x(d position)",PROCEDURE(p_get),},
-{"set",0,PARAM_NOSTATIC,"set value at position","p(d position,x value)",PROCEDURE(p_set),},
+{"get",0,PARAM_NOSTATIC,"get value at position","p x(d position)",PROCEDURE(p_get),"object[position] can be always used instead of object.get(position)"},
+{"set",0,PARAM_NOSTATIC,"set value at position","p(d position,x value)",PROCEDURE(p_set),"object[position]=value can be always used instead of object.set(position,value)"},
 {"add",0,PARAM_NOSTATIC,"append at the end","p(x value)",PROCEDURE(p_add),},
 {"find",0,PARAM_NOSTATIC,"find","p d(x value)",PROCEDURE(p_find),"returns the element index or -1 if not found"},
@@ -41 +46 @@
  "(\"key\" is the first argument in get/set/remove functions). Integer \"key\" can be "
  "used to enumerate all elements (the sequence of elements is not preserved).\n"
- "Example:\nvar d=Dictionary.new(); d.set(\"name\",\"John\"); d.set(\"age\",44);\n"
+ "Examples:\nvar d1=Dictionary.new(); d1.set(\"name\",\"John\"); d1.set(\"age\",44);\n"
+ "var d2=Dictionary.new(); d2[\"name\"]=\"John\"; d2[\"age\"]=44; //shorthand notation, equivalent to the line above\n"
  "var i;\nfor(i=0;i<d.size;i++) Simulator.print(d.getKey(i)+\" is \"+d.get(i));",},
 {"clear",0,PARAM_NOSTATIC,"clear data","p()",PROCEDURE(p_clear),},
 {"size",0,PARAM_NOSTATIC | PARAM_READONLY,"element count","d",GETONLY(size),},
 {"remove",0,PARAM_NOSTATIC,"remove named or indexed element","p(x key)",PROCEDURE(p_remove),},
-{"get",0,PARAM_NOSTATIC,"get named or indexed element","p x(x key)",PROCEDURE(p_get),},
+{"get",0,PARAM_NOSTATIC,"get named or indexed element","p x(x key)",PROCEDURE(p_get),"object[position] can be always used instead of object.get(position)"},
 {"getKey",0,PARAM_NOSTATIC,"get a key of the indexed element","p s(d index)",PROCEDURE(p_getKey),},
-{"set",0,PARAM_NOSTATIC,"set named or indexed element","p(x key,x value)",PROCEDURE(p_set),},
+{"set",0,PARAM_NOSTATIC,"set named or indexed element","p(x key,x value)",PROCEDURE(p_set),"object[key]=value can be always used instead of object.set(key,value)"},
 {"find",0,PARAM_NOSTATIC,"find","p s(x value)",PROCEDURE(p_find),"returns the element key or null if not found"},
 {"new",0,0,"create new Dictionary","p oDictionary()",STATICPROCEDURE(p_new),},