Changeset 387

Timestamp:

05/24/15 21:00:19 (10 years ago)

Author:

Maciej Komosinski

Message:

Improved help descriptions

File:

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

cpp/frams/vm/classes/collectionobj.cpp

@@ -15 +15 @@
 ParamEntry vector_paramtab[]=
 {
-{"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"
+{"Vector",1,13,"Vector","Vector is a 1-dimensional array indexed by an integer value (starting from 0). "
+ "Multidimensional arrays can be simulated by putting other Vector objects into a Vector.\n"
  "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"
+ "var v2=[123,\"string\"]; //a 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),},
@@ -45 +45 @@
 {"Dictionary",1,9,"Dictionary","Dictionary associates stored values with string keys "
  "(\"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"
+ "used to enumerate all elements (note that the sequence of elements is not preserved).\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 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),},