Skip to content

Commit f5094a4

Browse files
committed
docs: Update the docs
Signed-off-by: Ce Gao <ce.gao@outlook.com>
1 parent b12f9d0 commit f5094a4

File tree

112 files changed

+180
-3596
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+180
-3596
lines changed

docs/False.html renamed to docs/FALSE.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html>
33
<head>
4-
<title>False \ Language (API)</title>
4+
<title>FALSE \ Language (API)</title>
55
<link rel="icon" href="favicon.ico" type="image/x-icon" />
66
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
77
<meta name="Author" content="Ce Gao" />
@@ -35,14 +35,14 @@
3535
<table cellpadding="0" cellspacing="0" border="0" class="ref-item">
3636
<tr class="name-row">
3737
<th scope="row">Name</th>
38-
<td><h3>False</h3></td>
38+
<td><h3>FALSE</h3></td>
3939
</tr>
4040

4141

4242
<tr class="">
4343
<th scope="row">Description</th>
4444
<td>
45-
Reserved word representing the logical value "False". Only variables of type <b>Boolean</b> may be assigned the value <b>False</b>.
45+
Reserved word representing the logical value "FALSE".
4646
</td>
4747
</tr>
4848

@@ -54,7 +54,6 @@
5454

5555
<tr><th scope="row">Related</th><td class="code">
5656
<a class="code" href="./True.html">True</a><br />
57-
<a class="code" href="./Boolean.html">Boolean</a><br />
5857
</table>
5958

6059

docs/pass.html renamed to docs/NULL.html

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html>
33
<head>
4-
<title>pass \ Language (API)</title>
4+
<title>NULL \ Language (API)</title>
55
<link rel="icon" href="favicon.ico" type="image/x-icon" />
66
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
77
<meta name="Author" content="Ce Gao" />
@@ -35,22 +35,19 @@
3535
<table cellpadding="0" cellspacing="0" border="0" class="ref-item">
3636
<tr class="name-row">
3737
<th scope="row">Name</th>
38-
<td><h3>pass</h3></td>
38+
<td><h3>NULL</h3></td>
3939
</tr>
4040

4141

4242
<tr class="">
4343
<th scope="row">Description</th>
4444
<td>
45-
When pass is executed, nothing happens. Pass is useful when a statement is required syntactically -- as in the above function doNothing.
45+
NULL is often used to represent the absences of a value.
4646
</td>
4747
</tr>
4848

49-
<tr class=""><th scope="row">Syntax</th><td><pre><c>pass</c></pre></td></tr>
49+
<tr class=""><th scope="row">Syntax</th><td><pre>x = NULL</pre></td></tr>
5050

51-
<tr class=""><th scope="row">Parameters</th><td><table cellpadding="0" cellspacing="0" border="0">
52-
<tr class=""><th scope="row" class="code"></th><td></td></tr>
53-
</table></tr>
5451

5552

5653

docs/True.html renamed to docs/TRUE.html

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html>
33
<head>
4-
<title>True \ Language (API)</title>
4+
<title>TRUE \ Language (API)</title>
55
<link rel="icon" href="favicon.ico" type="image/x-icon" />
66
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
77
<meta name="Author" content="Ce Gao" />
@@ -35,29 +35,26 @@
3535
<table cellpadding="0" cellspacing="0" border="0" class="ref-item">
3636
<tr class="name-row">
3737
<th scope="row">Name</th>
38-
<td><h3>True</h3></td>
38+
<td><h3>TRUE</h3></td>
3939
</tr>
4040

4141

4242
<tr class="">
4343
<th scope="row">Description</th>
4444
<td>
45-
Reserved word representing the logical value "True".
45+
Reserved word representing the logical value "TRUE".
4646
</td>
4747
</tr>
4848

49-
<tr class=""><th scope="row">Syntax</th><td><pre> x = True
50-
y == True</pre></td></tr>
49+
<tr class=""><th scope="row">Syntax</th><td><pre> x = TRUE
50+
y ==TRUE</pre></td></tr>
5151

5252

5353

5454

5555

5656
<tr><th scope="row">Related</th><td class="code">
5757
<a class="code" href="./False.html">False</a><br />
58-
<a class="code" href="./Boolean.html">Boolean</a><br />
59-
<a class="code" href="./False.html">False</a><br />
60-
<a class="code" href="./Boolean.html">Boolean</a><br />
6158
</table>
6259

6360

docs/add_library.html

Lines changed: 0 additions & 80 deletions
This file was deleted.

docs/addassign.html

Lines changed: 0 additions & 85 deletions
This file was deleted.

docs/assign.html

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,24 +42,26 @@
4242
<tr class="">
4343
<th scope="row">Description</th>
4444
<td>
45-
Assigns a value to a variable. The "=" sign does not mean "equals", but is used to place data within a variable. The "=" operator is formally called the assignment operator. There are many different types of variables (int, floats, strings, etc.) and the assignment operator can only assign values which are the same type as the variable it is assigning. For example, if the variable is of type <b>int</b>, the value must also be an <b>int</b>.
45+
There are three different assignment operators: two of them have leftwards and rightwards forms.<br /> <br /> The operators <- and = assign into the environment in which they are evaluated. The operator <- can be used anywhere, whereas the operator = is only allowed at the top level (e.g., in the complete expression typed at the command prompt) or as one of the subexpressions in a braced list of expressions.<br /> <br /> The operators <<- and ->> are normally only used in functions, and cause a search to be made through parent environments for an existing definition of the variable being assigned. If such a variable is found (and its binding is not locked) then its value is redefined, otherwise assignment takes place in the global environment. Note that their semantics differ from that in the S language, but are useful in conjunction with the scoping rules of R. See ‘The R Language Definition’ manual for further details and examples.<br /> <br /> In all the assignment operator expressions, x can be a name or an expression defining a part of an object to be replaced (e.g., z[[1]]). A syntactic name does not need to be quoted, though it can be (preferably by backticks).<br /> <br /> The leftwards forms of assignment <- = <<- group right to left, the other from left to right.<br />
4646
</td>
4747
</tr>
4848

49-
<tr class=""><th scope="row">Syntax</th><td><pre><c>var</c> = <c>value</c></pre></td></tr>
49+
<tr class=""><th scope="row">Syntax</th><td><pre>x <- value
50+
x <<- value
51+
value -> x
52+
value ->> x
53+
54+
x = value</pre></td></tr>
5055

5156
<tr class=""><th scope="row">Parameters</th><td><table cellpadding="0" cellspacing="0" border="0">
52-
<tr class=""><th scope="row" class="code">var</th><td>any valid variable name</td></tr>
53-
<tr class=""><th scope="row" class="code">value</th><td>any value of the same type as the variable. For example, if the variable is of type "int", the value must also be an int</td></tr>
57+
<tr class=""><th scope="row" class="code">x</th><td>a variable name (possibly quoted).</td></tr>
58+
<tr class=""><th scope="row" class="code">value</th><td>a value to be assigned to x.</td></tr>
5459
</table></tr>
5560

5661

5762

5863

59-
<tr><th scope="row">Related</th><td class="code">
60-
<a class="code" href="./addassign.html">addassign</a><br />
61-
<a class="code" href="./subtractassign.html">subtractassign</a><br />
62-
</table>
64+
</table>
6365

6466

6567
<!-- Creative Commons License -->

docs/beginContour.html

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -38,30 +38,6 @@
3838
<td><h3>beginContour</h3></td>
3939
</tr>
4040

41-
<tr class=""><th scope="row">Examples</th><td>
42-
<div class="example"> <img src="img/beginContour1.png"/>
43-
<pre class='margin'># beginContour 1 https://processing.org/reference/beginContour_.html
44-
45-
size(100, 100)
46-
translate(50, 50)
47-
stroke(255, 0, 0)
48-
beginShape()
49-
# Exterior part of shape, clockwise winding
50-
vertex(-40, -40)
51-
vertex(40, -40)
52-
vertex(40, 40)
53-
vertex(-40, 40)
54-
# Interior part of shape, counter-clockwise winding
55-
beginContour()
56-
vertex(-20, -20)
57-
vertex(-20, 20)
58-
vertex(20, 20)
59-
vertex(20, -20)
60-
endContour()
61-
endShape(CLOSE)
62-
</pre>
63-
</div>
64-
</tr>
6541

6642
<tr class="">
6743
<th scope="row">Description</th>

0 commit comments

Comments
 (0)