Revision: 4884
http://sourceforge.net/p/vexi/code/4884
Author: clrg
Date: 2016-09-30 20:01:38 +0000 (Fri, 30 Sep 2016)
Log Message:
-----------
Improve docs
Modified Paths:
--------------
branches/vexi3/org.vexi-core.main/src/main/jpp/org/vexi/core/Vexi.jpp
branches/vexi3/org.vexi-library.js/src/main/java/org/ibex/js/JSU.java
branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JS.jpp
branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSArray.jpp
branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSPrimitive.jpp
branches/vexi3/org.vexi-library.net/src/main/java/org/ibex/net/JreHTTP.java
trunk/org.vexi-build.jsdoc/parser_setup.xml
trunk/org.vexi-build.jsdoc/src/poke/java/vexi/jsdoc/RunOnVexi.java
Modified: branches/vexi3/org.vexi-core.main/src/main/jpp/org/vexi/core/Vexi.jpp
===================================================================
--- branches/vexi3/org.vexi-core.main/src/main/jpp/org/vexi/core/Vexi.jpp
2016-09-29 14:09:31 UTC (rev 4883)
+++ branches/vexi3/org.vexi-core.main/src/main/jpp/org/vexi/core/Vexi.jpp
2016-09-30 20:01:38 UTC (rev 4884)
@@ -122,16 +122,16 @@
* <dd>
* <ul>
* <li><p><b>Charles Goodwin <<a
href="mailto:charles\\@webenableit.co.uk";>charles\\@webenableit.com</a>></b><br/>
- * Content author</li></p>
+ * Developer and principle content author</li></p>
* <li><p><b>Michael Goodwin <<a
href="mike\\@webenableit.co.uk">mike\\@webenableit.com</a>></b><br/>
- * Content author, Documentation tool author</p></li>
+ * Developer, content contributor, and documentation tool
author</p></li>
* </ul>
* <dd>
* <dt>AFT Inc. (<a href="http://www.aftinc.net/";
target="_top">www.aftinc.net</a>)</dt>
* <dd>
* <ul>
* <li><p><b>Adam Andrews</b><br/>
- * Contains modified portions of the Vexi 1.0 Function Reference
authored by Adam Andrews</p></li>
+ * Contains modified portions of the ‘Vexi 1.0 Function
Reference’ authored by Adam Andrews</p></li>
* </ul>
* <dd>
* <dt>Individuals</dt>
@@ -140,6 +140,10 @@
* <li><p><b>Adam Megacz (<a href="http://www.megacz.com";
target="_top">www.megacz.com</a>)</b><br/>
* Inspired by and contains modified portions of the <a
href="http://xwt.org/reference.html";>XWT
* Reference</a> authored by Adam Megacz</p></li>
+ * <li><p><b>David Crawshaw (<a
href="https://plus.google.com/+DavidCrawshaw"; target="_top">DavidCrawshaw
(GooglePlus)</a>)</b><br/>
+ * Key contributor to Vexi, and Ibex and XWT before it (notably the
JS engine)</p></li>
+ * <li><p><b>Brian Alliet (<a href="http://www.brianweb.net/";
target="_top">www.brianweb.net/</a>)</b><br/>
+ * Key contributor to Vexi, and Ibex and XWT before it (notably
NestedVM)</p></li>
* </ul>
* <dd>
* </dl>
Modified: branches/vexi3/org.vexi-library.js/src/main/java/org/ibex/js/JSU.java
===================================================================
--- branches/vexi3/org.vexi-library.js/src/main/java/org/ibex/js/JSU.java
2016-09-29 14:09:31 UTC (rev 4883)
+++ branches/vexi3/org.vexi-library.js/src/main/java/org/ibex/js/JSU.java
2016-09-30 20:01:38 UTC (rev 4884)
@@ -1,3 +1,7 @@
+// Copyright 2000-2016 the Contributors, as shown in the revision logs.
+// Licensed under the Apache Software License 2.0 ("the License").
+// You may not use this file except in compliance with the License.
+
package org.ibex.js;
import java.io.*;
Modified: branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JS.jpp
===================================================================
--- branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JS.jpp
2016-09-29 14:09:31 UTC (rev 4883)
+++ branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JS.jpp
2016-09-30 20:01:38 UTC (rev 4884)
@@ -60,12 +60,12 @@
* <h3>Write Traps</h3>
*
* <p>A write trap is a js function with a single argument, which is the value
being assigned to
- * the property. It should contain either a return or put to the
<code>cascade</code> keyword and
- * will produce a warning if neither is present.</p>
+ * the property. It should contain either <code>return</code> or
<code>cascade</code> and will
+ * produce a warning if neither is present.</p>
*
- * <p>To put a value to the property at any point in the function, put to the
<code>cascade</code>
- * keyword. This may only be done once per execution of a write trap.
<em>Note that putting to
- * the property directly will re-invoke the write trap.</em></p>
+ * <p>Put to the <code>cascade</code> keyword to put a value to the property
at any point in the
+ * function. This may only be done once per execution of a write trap.
<em>Note that putting
+ * to the property directly will re-invoke the write trap.</em></p>
*
* <p>To block a put - that is, cause the put to be ignored - simply
return.</p>
*
@@ -94,15 +94,15 @@
* <h3>Trap Chains</h3>
*
* <p>When assigning multiple read or write traps to the same property on the
same object, the
- * traps are stacked in order of assignment to create a trap chain.</p>
+ * trap functions are stacked in order of assignment to create a trap
chain.</p>
*
* <p>There are two paths of execution in a trap chain, known as
<em>pre-cascade</em> and
- * <em>post-cascade</em>. When a write or read occurs, the trap at the top of
the stack enters its
- * <em>pre-cascade</em> execution. When it <em>cascades</em> - either writing
to cascade (write
- * trap) or reading from cascade (read trap) - it passes the execution to the
next trap, and so on,
- * until either a trap returns or the put/get reaches the object. Then the
execution
- * enters the <em>post-cascade</em> of the next trap up in the stack fro the
return point, and
- * when a trap finishes, it passes the execution back up again in the
stack.</p>
+ * <em>post-cascade</em>. When a write or read occurs, the function at the
top of the stack enters its
+ * <em>pre-cascade</em> execution. When it <em>cascades</em> - either putting
to (write trap) or
+ * reading from (read trap) the <code>cascade<code> keyword - it passes the
execution to the next trap,
+ * and so on, until either a trap function blocks or the put/get reaches the
object. Then the execution
+ * enters the <em>post-cascade</em> in the function at the bottom of the stack
from the cascade/return
+ * point, and when the funciton finishes, it passes the execution back up
again in the stack.</p>
*
* <p>We refer to this execution path as <em>cascading</em> through the trap
chain.</p>
*
Modified:
branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSArray.jpp
===================================================================
--- branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSArray.jpp
2016-09-29 14:09:31 UTC (rev 4883)
+++ branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSArray.jpp
2016-09-30 20:01:38 UTC (rev 4884)
@@ -146,7 +146,7 @@
*/
case "splice": return METHOD;
- /* Returns array.join().
+ /* Returns ‘join()’ i.e. the contents of the array as
a comma-delimited string.
*
* @return(String)
* */
Modified:
branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSPrimitive.jpp
===================================================================
--- branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSPrimitive.jpp
2016-09-29 14:09:31 UTC (rev 4883)
+++ branches/vexi3/org.vexi-library.js/src/main/jpp/org/ibex/js/JSPrimitive.jpp
2016-09-30 20:01:38 UTC (rev 4884)
@@ -194,7 +194,7 @@
* <p>If either argument is less than 0, then the argument is treated
as the
* number of characters counted backwards from the end of the string.
If start
* is omitted, it defaults to the start of the string; if end is
omitted, it
- * defaults to the string\x92s length. If start is greater than end,
the function
+ * defaults to the string�s length. If start is greater than end, the
function
* returns "".</p>
*
* @param(name=start)
@@ -224,7 +224,7 @@
case "substr": return METHOD;
/* <p>Returns the section of the string between start and end —
1, inclusive.</p>
*
- * <p>If end is omitted, it defaults to the string\x92s length. If
both start and end
+ * <p>If end is omitted, it defaults to the string�s length. If both
start and end
* are omitted, then the entire string is returned. If start is
greater than end,
* the two values are swapped.</p>
*
@@ -251,16 +251,17 @@
// * @return(String)
// * */
// case "toFixed": if (this instanceof JSNumber) return METHOD;
- /* Returns the lower-case equivalent of the current string
+ /* Returns a copy of the string converted to lower-case.
* @return(String) */
case "toLowerCase": return METHOD;
- /* Returns the current string.
+ /* If the primitive is a string then returns itself, otherwise
returning a primitive's
+ * string equivalent.
* @return(String) */
case "toString": return METHOD;
- /* Returns the upper-case equivalent of the current string
+ /* Returns a copy of the string converted to upper-case.
* @return(String) */
case "toUpperCase": return METHOD;
- /* Returns the string with leading and trailing whitespace removed
+ /* Returns a copy of the string with leading and trailing whitespace
removed.
* @return(String) */
case "trim": return METHOD;
//#end
Modified:
branches/vexi3/org.vexi-library.net/src/main/java/org/ibex/net/JreHTTP.java
===================================================================
--- branches/vexi3/org.vexi-library.net/src/main/java/org/ibex/net/JreHTTP.java
2016-09-29 14:09:31 UTC (rev 4883)
+++ branches/vexi3/org.vexi-library.net/src/main/java/org/ibex/net/JreHTTP.java
2016-09-30 20:01:38 UTC (rev 4884)
@@ -107,7 +107,7 @@
String lengthStr =
connection.getHeaderField("Content-Length");
String contentTypeR =
connection.getHeaderField("Content-Type");
int length;
- if( lengthStr!=null) {
+ if (lengthStr!=null) {
length = Integer.parseInt(lengthStr);
} else {
length = -1;
Modified: trunk/org.vexi-build.jsdoc/parser_setup.xml
===================================================================
--- trunk/org.vexi-build.jsdoc/parser_setup.xml 2016-09-29 14:09:31 UTC (rev
4883)
+++ trunk/org.vexi-build.jsdoc/parser_setup.xml 2016-09-30 20:01:38 UTC (rev
4884)
@@ -4,10 +4,10 @@
<project name="project" default="javacc">
<property name="debug" value="false"/>
<target name="javacc" >
- <mkdir dir="src/gen/org/vexi/tools/autodoc/parse" />
+ <mkdir dir="src/gen/java/org/vexi/tools/autodoc/parse" />
<javacc
target="src/main/javacc/org/vexi/tools/autodoc/parse/Parser.jj"
- outputdirectory="src/gen/org/vexi/tools/autodoc/parse"
+ outputdirectory="src/gen/java/org/vexi/tools/autodoc/parse"
debugparser="${debug}"
debugtokenmanager="${debug}"
javacchome="lib_build/javacc-4.2"
Modified: trunk/org.vexi-build.jsdoc/src/poke/java/vexi/jsdoc/RunOnVexi.java
===================================================================
--- trunk/org.vexi-build.jsdoc/src/poke/java/vexi/jsdoc/RunOnVexi.java
2016-09-29 14:09:31 UTC (rev 4883)
+++ trunk/org.vexi-build.jsdoc/src/poke/java/vexi/jsdoc/RunOnVexi.java
2016-09-30 20:01:38 UTC (rev 4884)
@@ -41,7 +41,7 @@
JSDoc jsdoc = new JSDoc(path, new File("vexi_jsdoc")){{
setName("Vexi");
setVersion(RunOnVexi.version);
- setCopyRight("Copyright
"+Calendar.getInstance().get(Calendar.YEAR)+" The Vexi Project");
+
setCopyRight(Calendar.getInstance().get(Calendar.YEAR)+" The Vexi Project");
setProjectWWW("vexi.sourceforge.net");
addLibraryRoot("vexi", "org.vexi.core.Vexi");
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Vexi-svn mailing list
Vexi-svn@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/vexi-svn
