Documentation

c0pperdragon · Feb 3, 2018 · a1f7956 · a1f7956
1 parent b741220
commit a1f7956
Show file tree

Hide file tree

Showing 13 changed files with 1,599 additions and 298 deletions.
diff --git a/Documentation/Documentation.csproj b/Documentation/Documentation.csproj
@@ -71,6 +71,7 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="Resources\ManualRU.txt" />
+    <Content Include="SmallBasicEV3Extension.pl.XML" />
     <Content Include="SmallBasicEV3Extension.ru.XML">
       <SubType>Designer</SubType>
     </Content>

diff --git a/Documentation/DocumentationGenerator.cs b/Documentation/DocumentationGenerator.cs
@@ -48,7 +48,7 @@ static void Main(String[] args)
                      "EV3Basic Benutzerhandbuch",
                      Documentation.Properties.Resources.ManualDE,
                      Documentation.Properties.Resources.Appendix,
-                     "Rückgabewert",
+                     "Gibt zurück",
                      "Eigenschaft",
                      "C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/ev3basic_handbuch.html"
                      );
@@ -57,7 +57,7 @@ static void Main(String[] args)
                      "EV3Basic Developer Manual",
                      Documentation.Properties.Resources.ManualFR,
                      Documentation.Properties.Resources.AppendixFR,
-                     "Résultats",
+                     "Retourne",
                      "Propriété",
                      "C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/ev3basic_manuel.html"
                      );
@@ -66,8 +66,8 @@ static void Main(String[] args)
                      "EV3Basic Developer Manual",
                      Documentation.Properties.Resources.ManualES,
                      Documentation.Properties.Resources.Appendix,
-                     "Returns",
-                     "Property",
+                     "Devuelve",
+                     "Propiedad",
                      "C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/ev3basic_manual_es.html"
                      );
 
@@ -76,8 +76,8 @@ static void Main(String[] args)
                      "EV3Basic Developer Manual",
                      Documentation.Properties.Resources.ManualRU,
                      Documentation.Properties.Resources.Appendix,
-                     "Returns",
-                     "Property",
+                     "Возвращает",
+                     "Свойство",
                      "C:/Users/Reinhard/Documents/GitHub/EV3Basic/Documentation/ev3basic_manual_ru.html"
                      );
         }

diff --git a/Documentation/Resources/ManualDE.txt b/Documentation/Resources/ManualDE.txt
@@ -28,7 +28,7 @@ reinhard.grafl@aon.at
 
 <H1 class="chapter">Erste Schritte</H1>
 <P>
-Was man zuerst braucht, ist ein PC mit Microsoft Windows (jede Version seit Windows XP) und die aktuelle Version von
+Was man zuerst braucht, ist ein PC mit Microsoft Windows (jede Version seit Windows Vista) und die aktuelle Version von
 <a href="http://smallbasic.com">Microsoft Small Basic</a> die man sich gratis runterladen kann. F�r komplette Programmier-Neulinge empfehle 
 ich die Tutorials auf Small Basic - Webseite um die grundlegenden Prinzipien zu erlernen. Das dauert nicht all zu lange und macht f�r sich
 alleine auch schon Spa�. 

diff --git a/Documentation/SmallBasicEV3Extension.de.XML b/Documentation/SmallBasicEV3Extension.de.XML
diff --git a/Documentation/ev3basic_handbuch.html b/Documentation/ev3basic_handbuch.html
diff --git a/Documentation/ev3basic_manual.html b/Documentation/ev3basic_manual.html
@@ -641,12 +641,16 @@ <H3 class="operation">F.Call0 (name)</H3>
 <P class="operationsummary">Do a function call without passing parameters.</P>
 <H4 class="parameter">name</H4>
 <P class="parametersummary">The name of the function (case insensitive)</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call1 (name, p1)</H3>
 <P class="operationsummary">Do a function call with 1 parameter.</P>
 <H4 class="parameter">name</H4>
 <P class="parametersummary">The name of the function (case insensitive)</P>
 <H4 class="parameter">p1</H4>
 <P class="parametersummary">Parameter 1</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call10 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10)</H3>
 <P class="operationsummary">Do a function call with 10 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -671,6 +675,8 @@ <H4 class="parameter">p9</H4>
 <P class="parametersummary">Parameter 9</P>
 <H4 class="parameter">p10</H4>
 <P class="parametersummary">Parameter 10</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call11 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11)</H3>
 <P class="operationsummary">Do a function call with 11 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -697,6 +703,8 @@ <H4 class="parameter">p10</H4>
 <P class="parametersummary">Parameter 10</P>
 <H4 class="parameter">p11</H4>
 <P class="parametersummary">Parameter 11</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call12 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12)</H3>
 <P class="operationsummary">Do a function call with 12 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -725,6 +733,8 @@ <H4 class="parameter">p11</H4>
 <P class="parametersummary">Parameter 11</P>
 <H4 class="parameter">p12</H4>
 <P class="parametersummary">Parameter 12</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call13 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13)</H3>
 <P class="operationsummary">Do a function call with 13 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -755,6 +765,8 @@ <H4 class="parameter">p12</H4>
 <P class="parametersummary">Parameter 12</P>
 <H4 class="parameter">p13</H4>
 <P class="parametersummary">Parameter 13</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call14 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13, p14)</H3>
 <P class="operationsummary">Do a function call with 14 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -787,6 +799,8 @@ <H4 class="parameter">p13</H4>
 <P class="parametersummary">Parameter 13</P>
 <H4 class="parameter">p14</H4>
 <P class="parametersummary">Parameter 14</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call15 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13, p14, p15)</H3>
 <P class="operationsummary">Do a function call with 15 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -821,6 +835,8 @@ <H4 class="parameter">p14</H4>
 <P class="parametersummary">Parameter 14</P>
 <H4 class="parameter">p15</H4>
 <P class="parametersummary">Parameter 15</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call16 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13, p14, p15, p16)</H3>
 <P class="operationsummary">Do a function call with 16 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -857,6 +873,8 @@ <H4 class="parameter">p15</H4>
 <P class="parametersummary">Parameter 15</P>
 <H4 class="parameter">p16</H4>
 <P class="parametersummary">Parameter 16</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call17 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13, p14, p15, p16, p17)</H3>
 <P class="operationsummary">Do a function call with 17 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -895,10 +913,16 @@ <H4 class="parameter">p16</H4>
 <P class="parametersummary">Parameter 16</P>
 <H4 class="parameter">p17</H4>
 <P class="parametersummary">Parameter 17</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call18 ()</H3>
 <P class="operationsummary">Do a function call with 18 parameters.<BR>The name of the function (case insensitive)Parameter 1Parameter 2Parameter 3Parameter 4Parameter 5Parameter 6Parameter 7Parameter 8Parameter 9Parameter 10Parameter 11Parameter 12Parameter 13Parameter 14Parameter 15Parameter 16Parameter 17Parameter 18</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call19 ()</H3>
 <P class="operationsummary">Do a function call with 19 parameters.<BR>The name of the function (case insensitive)Parameter 1Parameter 2Parameter 3Parameter 4Parameter 5Parameter 6Parameter 7Parameter 8Parameter 9Parameter 10Parameter 11Parameter 12Parameter 13Parameter 14Parameter 15Parameter 16Parameter 17Parameter 18Parameter 19</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call2 (name, p1, p2)</H3>
 <P class="operationsummary">Do a function call with 2 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -907,6 +931,8 @@ <H4 class="parameter">p1</H4>
 <P class="parametersummary">Parameter 1</P>
 <H4 class="parameter">p2</H4>
 <P class="parametersummary">Parameter 2</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call20 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13, p14, p15, p16, p17, p18, p19, p20)</H3>
 <P class="operationsummary">Do a function call with 20 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -951,6 +977,8 @@ <H4 class="parameter">p19</H4>
 <P class="parametersummary">Parameter 19</P>
 <H4 class="parameter">p20</H4>
 <P class="parametersummary">Parameter 20</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call3 (name, p1, p2, p3)</H3>
 <P class="operationsummary">Do a function call with 3 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -961,6 +989,8 @@ <H4 class="parameter">p2</H4>
 <P class="parametersummary">Parameter 2</P>
 <H4 class="parameter">p3</H4>
 <P class="parametersummary">Parameter 3</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call4 (name, p1, p2, p3, p4)</H3>
 <P class="operationsummary">Do a function call with 4 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -973,6 +1003,8 @@ <H4 class="parameter">p3</H4>
 <P class="parametersummary">Parameter 3</P>
 <H4 class="parameter">p4</H4>
 <P class="parametersummary">Parameter 4</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call5 (name, p1, p2, p3, p4, p5)</H3>
 <P class="operationsummary">Do a function call with 5 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -987,6 +1019,8 @@ <H4 class="parameter">p4</H4>
 <P class="parametersummary">Parameter 4</P>
 <H4 class="parameter">p5</H4>
 <P class="parametersummary">Parameter 5</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call6 (name, p1, p2, p3, p4, p5, p6)</H3>
 <P class="operationsummary">Do a function call with 6 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -1003,6 +1037,8 @@ <H4 class="parameter">p5</H4>
 <P class="parametersummary">Parameter 5</P>
 <H4 class="parameter">p6</H4>
 <P class="parametersummary">Parameter 6</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call7 (name, p1, p2, p3, p4, p5, p6, p7)</H3>
 <P class="operationsummary">Do a function call with 7 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -1021,6 +1057,8 @@ <H4 class="parameter">p6</H4>
 <P class="parametersummary">Parameter 6</P>
 <H4 class="parameter">p7</H4>
 <P class="parametersummary">Parameter 7</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call8 (name, p1, p2, p3, p4, p5, p6, p7, p8)</H3>
 <P class="operationsummary">Do a function call with 8 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -1041,6 +1079,8 @@ <H4 class="parameter">p7</H4>
 <P class="parametersummary">Parameter 7</P>
 <H4 class="parameter">p8</H4>
 <P class="parametersummary">Parameter 8</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Call9 (name, p1, p2, p3, p4, p5, p6, p7, p8, p9)</H3>
 <P class="operationsummary">Do a function call with 9 parameters.</P>
 <H4 class="parameter">name</H4>
@@ -1063,12 +1103,14 @@ <H4 class="parameter">p8</H4>
 <P class="parametersummary">Parameter 8</P>
 <H4 class="parameter">p9</H4>
 <P class="parametersummary">Parameter 9</P>
+<H4 class="returns">Returns</H4>
+<P class="returnssummary">The value returned by the function</P>
 <H3 class="operation">F.Function (name, parameterdefinitions)</H3>
 <P class="operationsummary">Define a named function and its local variables/parameters with default values. Before this command is executed, the Start property needs to be set to a subroutine that will then be the starting point of the function.<BR>The local variables are also used for parameter passing when using a Call command: For any call with n parameters, these parameters will be assigned to the first n local variables. The rest of the local variables will be set to their defined initial value.</P>
 <H4 class="parameter">name</H4>
 <P class="parametersummary">The name for the function (needs to be a string literal)</P>
 <H4 class="parameter">parameterdefinitions</H4>
-<P class="parametersummary">A string that holds a sequence of local variable names and initial values. This looks like for example "A B:5 T:hello". When do default is specified, 0 will be used.</P>
+<P class="parametersummary">A string that holds a sequence of local variable names and initial values. This looks like for example "A B:5 T:hello". When no default is specified, 0 will be used.</P>
 <H3 class="operation">F.Get (variablename)</H3>
 <P class="operationsummary">Retrieve the value of a named local variable.</P>
 <H4 class="parameter">variablename</H4>
@@ -1824,11 +1866,11 @@ <H4 class="parameter">B</H4>
 <H4 class="returns">Returns</H4>
 <P class="returnssummary">A vector of the given size what contains sum values</P>
 <H3 class="operation">Vector.Data (size, data)</H3>
-<P class="operationsummary">Set up a vector of a given size and initialize the elements with data drawn from a string. For this, the string will be split apart on blank spaces and every part is treated as a decimal number.<BR>For example: V = Vector.Data(4,"47 11 8 15") will result in an number array with the 4 values 47 11 8 15.</P>
+<P class="operationsummary">Set up a vector of a given size and initialize the elements with data drawn from a text. For this, the text will be split apart on blank spaces and every part is treated as a decimal number.<BR>For example: V = Vector.Data(4,"47 11 8 15") will result in an number array with the 4 values 47 11 8 15.</P>
 <H4 class="parameter">size</H4>
 <P class="parametersummary">Size of the resulting vector</P>
 <H4 class="parameter">data</H4>
-<P class="parametersummary">Data in string form to be filled into the array. When the string contains too few elements, the vector is padded with 0 to reach the specified number of elements</P>
+<P class="parametersummary">Data in text form to be filled into the array. When the text contains too few elements, the vector is padded with 0 to reach the specified number of elements</P>
 <H4 class="returns">Returns</H4>
 <P class="returnssummary">The created vector</P>
 <H3 class="operation">Vector.Init (size, value)</H3>