Skip to content

Commit db91449

Browse files
committed
Changed comments for all the web references in core
1 parent 2e8a2b7 commit db91449

21 files changed

+910
-675
lines changed

core/src/processing/awt/PGraphicsJava2D.java

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -993,13 +993,43 @@ public void noClip() {
993993
// BLEND
994994

995995
/**
996-
* ( begin auto-generated from blendMode.xml )
997996
*
998-
* This is a new reference entry for Processing 2.0. It will be updated shortly.
997+
* Blends the pixels in the display window according to a defined mode.
998+
* There is a choice of the following modes to blend the source pixels (A)
999+
* with the ones of pixels already in the display window (B). Each pixel's
1000+
* final color is the result of applying one of the blend modes with each
1001+
* channel of (A) and (B) independently. The red channel is compared with
1002+
* red, green with green, and blue with blue.<br />
1003+
* <br />
1004+
* BLEND - linear interpolation of colors: C = A*factor + B. This is the default.<br />
1005+
* <br />
1006+
* ADD - additive blending with white clip: C = min(A*factor + B, 255)<br />
1007+
* <br />
1008+
* SUBTRACT - subtractive blending with black clip: C = max(B - A*factor, 0)<br />
1009+
* <br />
1010+
* DARKEST - only the darkest color succeeds: C = min(A*factor, B)<br />
1011+
* <br />
1012+
* LIGHTEST - only the lightest color succeeds: C = max(A*factor, B)<br />
1013+
* <br />
1014+
* DIFFERENCE - subtract colors from underlying image.<br />
1015+
* <br />
1016+
* EXCLUSION - similar to DIFFERENCE, but less extreme.<br />
1017+
* <br />
1018+
* MULTIPLY - multiply the colors, result will always be darker.<br />
1019+
* <br />
1020+
* SCREEN - opposite multiply, uses inverse values of the colors.<br />
1021+
* <br />
1022+
* REPLACE - the pixels entirely replace the others and don't utilize alpha (transparency) values<br />
1023+
* <br />
1024+
* We recommend using <b>blendMode()</b> and not the previous <b>blend()</b>
1025+
* function. However, unlike <b>blend()</b>, the <b>blendMode()</b> function
1026+
* does not support the following: HARD_LIGHT, SOFT_LIGHT, OVERLAY, DODGE,
1027+
* BURN. On older hardware, the LIGHTEST, DARKEST, and DIFFERENCE modes might
1028+
* not be available as well.
9991029
*
1000-
* ( end auto-generated )
10011030
*
10021031
* @webref Rendering
1032+
* @webBrief Blends the pixels in the display window according to a defined mode.
10031033
* @param mode the blending mode to use
10041034
*/
10051035
@Override

core/src/processing/core/PConstants.java

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,14 @@ public interface PConstants {
128128
// useful goodness
129129

130130
/**
131-
* ( begin auto-generated from PI.xml )
132131
*
133132
* PI is a mathematical constant with the value 3.14159265358979323846. It
134133
* is the ratio of the circumference of a circle to its diameter. It is
135134
* useful in combination with the trigonometric functions <b>sin()</b> and
136135
* <b>cos()</b>.
137136
*
138-
* ( end auto-generated )
139137
* @webref constants
138+
* @webBrief PI is a mathematical constant with the value 3.14159265358979323846.
140139
* @see PConstants#TWO_PI
141140
* @see PConstants#TAU
142141
* @see PConstants#HALF_PI
@@ -145,15 +144,14 @@ public interface PConstants {
145144
*/
146145
static final float PI = (float) Math.PI;
147146
/**
148-
* ( begin auto-generated from HALF_PI.xml )
149147
*
150148
* HALF_PI is a mathematical constant with the value
151149
* 1.57079632679489661923. It is half the ratio of the circumference of a
152150
* circle to its diameter. It is useful in combination with the
153151
* trigonometric functions <b>sin()</b> and <b>cos()</b>.
154152
*
155-
* ( end auto-generated )
156153
* @webref constants
154+
* @webBrief HALF_PI is a mathematical constant with the value 1.57079632679489661923.
157155
* @see PConstants#PI
158156
* @see PConstants#TWO_PI
159157
* @see PConstants#TAU
@@ -162,47 +160,44 @@ public interface PConstants {
162160
static final float HALF_PI = (float) (Math.PI / 2.0);
163161
static final float THIRD_PI = (float) (Math.PI / 3.0);
164162
/**
165-
* ( begin auto-generated from QUARTER_PI.xml )
166163
*
167164
* QUARTER_PI is a mathematical constant with the value 0.7853982. It is
168165
* one quarter the ratio of the circumference of a circle to its diameter.
169166
* It is useful in combination with the trigonometric functions
170167
* <b>sin()</b> and <b>cos()</b>.
171168
*
172-
* ( end auto-generated )
173169
* @webref constants
170+
* @webBrief QUARTER_PI is a mathematical constant with the value 0.7853982.
174171
* @see PConstants#PI
175172
* @see PConstants#TWO_PI
176173
* @see PConstants#TAU
177174
* @see PConstants#HALF_PI
178175
*/
179176
static final float QUARTER_PI = (float) (Math.PI / 4.0);
180177
/**
181-
* ( begin auto-generated from TWO_PI.xml )
182178
*
183179
* TWO_PI is a mathematical constant with the value 6.28318530717958647693.
184180
* It is twice the ratio of the circumference of a circle to its diameter.
185181
* It is useful in combination with the trigonometric functions
186182
* <b>sin()</b> and <b>cos()</b>.
187183
*
188-
* ( end auto-generated )
189184
* @webref constants
185+
* @webBrief TWO_PI is a mathematical constant with the value 6.28318530717958647693.
190186
* @see PConstants#PI
191187
* @see PConstants#TAU
192188
* @see PConstants#HALF_PI
193189
* @see PConstants#QUARTER_PI
194190
*/
195191
static final float TWO_PI = (float) (2.0 * Math.PI);
196192
/**
197-
* ( begin auto-generated from TAU.xml )
198193
*
199194
* TAU is an alias for TWO_PI, a mathematical constant with the value
200195
* 6.28318530717958647693. It is twice the ratio of the circumference
201196
* of a circle to its diameter. It is useful in combination with the
202197
* trigonometric functions <b>sin()</b> and <b>cos()</b>.
203198
*
204-
* ( end auto-generated )
205199
* @webref constants
200+
* @webBrief An alias for TWO_PI
206201
* @see PConstants#PI
207202
* @see PConstants#TWO_PI
208203
* @see PConstants#HALF_PI

core/src/processing/core/PFont.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
* ^^^^^^^^^^^^^^ setWidth (width displaced by char)
5757
* </PRE>
5858
* @webref typography
59+
* @webBrief Grayscale bitmap font class used by Processing.
5960
* @see PApplet#loadFont(String)
6061
* @see PApplet#createFont(String, float, boolean, char[])
6162
* @see PGraphics#textFont(PFont)
@@ -869,17 +870,16 @@ public PShape getShape(char ch, float detail) {
869870

870871

871872
/**
872-
* ( begin auto-generated from PFont_list.xml )
873873
*
874874
* Gets a list of the fonts installed on the system. The data is returned
875875
* as a String array. This list provides the names of each font for input
876876
* into <b>createFont()</b>, which allows Processing to dynamically format
877877
* fonts. This function is meant as a tool for programming local
878878
* applications and is not recommended for use in applets.
879879
*
880-
* ( end auto-generated )
881880
*
882881
* @webref pfont
882+
* @webBrief Gets a list of the fonts installed on the system.
883883
* @usage application
884884
* @brief Gets a list of the fonts installed on the system
885885
*/

0 commit comments

Comments
 (0)