Changes to doclet and code comments

core/src/processing/awt/PGraphicsJava2D.java

@@ -1029,7 +1029,7 @@ public void noClip() {
    *
    *
    * @webref Rendering
-   * @webBrief Blends the pixels in the display window according to a defined mode. 
+   * @webBrief Blends the pixels in the display window according to a defined mode
    * @param mode the blending mode to use
    */
   @Override

core/src/processing/core/PConstants.java

@@ -135,7 +135,7 @@ public interface PConstants {
    *
    * @webref constants
    * @webBrief PI is a mathematical constant with the value
-   *           3.14159265358979323846.
+   *           3.14159265358979323846
    * @see PConstants#TWO_PI
    * @see PConstants#TAU
    * @see PConstants#HALF_PI
@@ -152,7 +152,7 @@ public interface PConstants {
    *
    * @webref constants
    * @webBrief HALF_PI is a mathematical constant with the value
-   *           1.57079632679489661923.
+   *           1.57079632679489661923
    * @see PConstants#PI
    * @see PConstants#TWO_PI
    * @see PConstants#TAU
@@ -168,7 +168,7 @@ public interface PConstants {
    * <b>sin()</b> and <b>cos()</b>.
    *
    * @webref constants
-   * @webBrief QUARTER_PI is a mathematical constant with the value 0.7853982.
+   * @webBrief QUARTER_PI is a mathematical constant with the value 0.7853982
    * @see PConstants#PI
    * @see PConstants#TWO_PI
    * @see PConstants#TAU
@@ -183,7 +183,7 @@ public interface PConstants {
    * <b>sin()</b> and <b>cos()</b>.
    *
    * @webref constants
-   * @webBrief TWO_PI is a mathematical constant with the value 6.28318530717958647693.
+   * @webBrief TWO_PI is a mathematical constant with the value 6.28318530717958647693
    * @see PConstants#PI
    * @see PConstants#TAU
    * @see PConstants#HALF_PI
@@ -199,7 +199,7 @@ public interface PConstants {
    * <b>cos()</b>.
    *
    * @webref constants
-   * @webBrief An alias for TWO_PI
+   * @webBrief An alias for <b>TWO_PI</b>
    * @see PConstants#PI
    * @see PConstants#TWO_PI
    * @see PConstants#HALF_PI

core/src/processing/core/PFont.java

@@ -72,7 +72,7 @@
  * </PRE>
  *
  * @webref typography
- * @webBrief Grayscale bitmap font class used by Processing.
+ * @webBrief Grayscale bitmap font class used by Processing
  * @see PApplet#loadFont(String)
  * @see PApplet#createFont(String, float, boolean, char[])
  * @see PGraphics#textFont(PFont)
@@ -876,7 +876,7 @@ public PShape getShape(char ch, float detail) {
    *
    *
    * @webref pfont
-   * @webBrief Gets a list of the fonts installed on the system.
+   * @webBrief Gets a list of the fonts installed on the system
    * @usage application
    * @brief Gets a list of the fonts installed on the system
    */

core/src/processing/core/PImage.java

@@ -54,7 +54,7 @@
  *
  *
  * @webref image
- * @webBrief Datatype for storing images.
+ * @webBrief Datatype for storing images
  * @usage Web & Application
  * @instanceName pimg any object of type PImage
  * @see PApplet#loadImage(String)
@@ -83,7 +83,7 @@ public class PImage implements PConstants, Cloneable {
 
   /**
    *
-   * The pixels[] array contains the values for all the pixels in the image. These
+   * The <b>pixels[]</b> array contains the values for all the pixels in the image. These
    * values are of the color datatype. This array is the size of the image,
    * meaning if the image is 100 x 100 pixels, there will be 10,000 values and if
    * the window is 200 x 300 pixels, there will be 60,000 values. <br />
@@ -96,7 +96,7 @@ public class PImage implements PConstants, Cloneable {
    *
    *
    * @webref image:pixels
-   * @webBrief Array containing the color of every pixel in the image.
+   * @webBrief Array containing the color of every pixel in the image
    * @usage web_application
    */
   public int[] pixels;
@@ -113,7 +113,7 @@ public class PImage implements PConstants, Cloneable {
    * The width of the image in units of pixels.
    *
    * @webref pimage:field
-   * @webBrief The width of the image in units of pixels.
+   * @webBrief The width of the image in units of pixels
    * @usage web_application
    */
   public int width;
@@ -123,7 +123,7 @@ public class PImage implements PConstants, Cloneable {
    * The height of the image in units of pixels.
    *
    * @webref pimage:field
-   * @webBrief The height of the image in units of pixels.
+   * @webBrief The height of the image in units of pixels
    * @usage web_application
    */
   public int height;
@@ -379,7 +379,7 @@ public int getModifiedY2() {  // ignore
    * copy all data into the pixels[] array
    *
    * @webref pimage:pixels
-   * @webBrief Loads the pixel data for the image into its <b>pixels[]</b> array.
+   * @webBrief Loads the pixel data for the image into its <b>pixels[]</b> array
    * @usage web_application
    */
   public void loadPixels() {  // ignore
@@ -408,7 +408,7 @@ public void updatePixels() {  // ignore
    * future.
    *
    * @webref pimage:pixels
-   * @webBrief Updates the image with the data in its <b>pixels[]</b> array.
+   * @webBrief Updates the image with the data in its <b>pixels[]</b> array
    * @usage web_application
    * @param x x-coordinate of the upper-left corner
    * @param y y-coordinate of the upper-left corner
@@ -464,17 +464,17 @@ public Object clone() throws CloneNotSupportedException {  // ignore
    * Resize the image to a new width and height. To make the image scale
    * proportionally, use 0 as the value for the <b>wide</b> or <b>high</b>
    * parameter. For instance, to make the width of an image 150 pixels, and
-   * change the height using the same proportion, use resize(150, 0).<br />
+   * change the height using the same proportion, use <b>resize(150, 0)</b>.<br />
    * <br />
-   * Even though a PGraphics is technically a PImage, it is not possible to
-   * rescale the image data found in a PGraphics. (It's simply not possible
+   * Even though a PGraphics is technically a <b>PImage</b>, it is not possible to
+   * rescale the image data found in a <b>PGraphics</b>. (It's simply not possible
    * to do this consistently across renderers: technically infeasible with
-   * P3D, or what would it even do with PDF?) If you want to resize PGraphics
+   * P3D, or what would it even do with PDF?) If you want to resize <b>PGraphics</b>
    * content, first get a copy of its image data using the <b>get()</b>
    * method, and call <b>resize()</b> on the PImage that is returned.
    *
    * @webref pimage:method
-   * @webBrief Resize the image to a new width and height.
+   * @webBrief Resize the image to a new width and height
    * @usage web_application
    * @param w the resized image width
    * @param h the resized image height
@@ -551,7 +551,7 @@ public void setLoaded(boolean l) {  // ignore
    * pixels[] array directly.
    *
    * @webref image:pixels
-   * @webBrief Reads the color of any pixel or grabs a rectangle of pixels.
+   * @webBrief Reads the color of any pixel or grabs a rectangle of pixels
    * @usage web_application
    * @param x x-coordinate of the pixel
    * @param y y-coordinate of the pixel
@@ -1582,7 +1582,7 @@ public void copy(PImage src,
    *
    * @webref color:creating_reading
    * @webBrief Blends two color values together based on the blending mode given as the
-   * <b>MODE</b> parameter.
+   * <b>MODE</b> parameter
    * @usage web_application
    * @param c1 the first color to blend
    * @param c2 the second color to blend
@@ -1631,16 +1631,16 @@ public void blend(int sx, int sy, int sw, int sh,
    * of the following modes to blend the colors of source pixels (A) with the
    * ones of pixels in the destination image (B):<br />
    * <br />
-   * BLEND - linear interpolation of colours: C = A*factor + B<br />
+   * BLEND - linear interpolation of colours: <b>C = A*factor + B</b><br />
    * <br />
-   * ADD - additive blending with white clip: C = min(A*factor + B, 255)<br />
+   * ADD - additive blending with white clip: <b>C = min(A*factor + B, 255)</b><br />
    * <br />
-   * SUBTRACT - subtractive blending with black clip: C = max(B - A*factor,
-   * 0)<br />
+   * SUBTRACT - subtractive blending with black clip: <b>C = max(B - A*factor,
+   * 0)</b><br />
    * <br />
-   * DARKEST - only the darkest colour succeeds: C = min(A*factor, B)<br />
+   * DARKEST - only the darkest colour succeeds: <b>C = min(A*factor, B)</b><br />
    * <br />
-   * LIGHTEST - only the lightest colour succeeds: C = max(A*factor, B)<br />
+   * LIGHTEST - only the lightest colour succeeds: <b>C = max(A*factor, B)</b><br />
    * <br />
    * DIFFERENCE - subtract colors from underlying image.<br />
    * <br />
@@ -1674,7 +1674,7 @@ public void blend(int sx, int sy, int sw, int sh,
    *
    *
    * @webref image:pixels
-   * @webBrief Copies a pixel or rectangle of pixels using different blending modes.
+   * @webBrief Copies a pixel or rectangle of pixels using different blending modes
    * @param src an image variable referring to the source image
    * @param sx X coordinate of the source's upper left corner
    * @param sy Y coordinate of the source's upper left corner
@@ -3289,7 +3289,7 @@ protected boolean saveTGA(OutputStream output) {
    * file with no error.
    *
    * @webref pimage:method
-   * @webBrief Saves the image to a TIFF, TARGA, PNG, or JPEG file.
+   * @webBrief Saves the image to a TIFF, TARGA, PNG, or JPEG file
    * @usage application
    * @param filename a sequence of letters and numbers
    */

core/src/processing/core/PShape.java

@@ -87,7 +87,7 @@
  * </p>
  *
  * @webref shape
- * @webBrief Datatype for storing shapes.
+ * @webBrief Datatype for storing shapes
  * @usage Web &amp; Application
  * @see PApplet#loadShape(String)
  * @see PApplet#createShape()
@@ -145,7 +145,7 @@ public class PShape implements PConstants {
 
   /**
    *
-   * The width of the PShape document.
+   * The width of the <b>PShape</b> document.
    *
    * @webref pshape:field
    * @usage web_application
@@ -155,7 +155,7 @@ public class PShape implements PConstants {
   public float width;
   /**
    *
-   * The height of the PShape document.
+   * The height of the <b>PShape</b> document.
    *
    * @webref pshape:field
    * @usage web_application
@@ -400,7 +400,7 @@ public String getName() {
 
   /**
    *
-   * Returns a boolean value "true" if the image is set to be visible, "false" if
+   * Returns a boolean value <b>true</b> if the image is set to be visible, <b>false</b> if
    * not. This value can be modified with the <b>setVisible()</b> method.<br />
    * <br />
    * The default visibility of a shape is usually controlled by whatever program
@@ -409,8 +409,8 @@ public String getName() {
    *
    * @webref pshape:method
    * @usage web_application
-   * @webBrief Returns a boolean value "true" if the image is set to be visible,
-   *           "false" if not
+   * @webBrief Returns a boolean value <b>true</b> if the image is set to be visible,
+   *           <b>false</b> if not
    * @see PShape#setVisible(boolean)
    */
   public boolean isVisible() {
@@ -781,7 +781,7 @@ public void attrib(String name, boolean... values) {
    * function. It's always and only used with <b>createShape()</b>. 
    * 
    * @webref pshape:method
-   * @webBrief Starts the creation of a new PShape
+   * @webBrief Starts the creation of a new <b>PShape</b>
    * @see PApplet#endShape()
    */
   public void beginShape() {
@@ -799,7 +799,7 @@ public void beginShape(int kind) {
    * function. It's always and only used with <b>createShape()</b>. 
    *
    * @webref pshape:method
-   * @webBrief Finishes the creation of a new PShape
+   * @webBrief Finishes the creation of a new <b>PShape</b>
    * @see PApplet#beginShape()
    */
   public void endShape() {
@@ -2005,7 +2005,7 @@ public PShape getParent() {
   }
 
   /**
-   * Returns the number of children within the PShape.
+   * Returns the number of children within the <b>PShape</b>.
    * 
    * @webref
    * @webBrief Returns the number of children
@@ -2037,7 +2037,7 @@ public PShape[] getChildren() {
    *
    * @webref pshape:method
    * @usage web_application
-   * @webBrief Returns a child element of a shape as a PShape object
+   * @webBrief Returns a child element of a shape as a <b>PShape</b> object
    * @param index the layer position of the shape to get
    * @see PShape#addChild(PShape)
    */
@@ -2256,7 +2256,7 @@ protected void setPath(int vcount, float[][] verts, int ccount, int[] codes) {
 
   /**
    * The <b>getVertexCount()</b> method returns the number of vertices that 
-   * make up a PShape. In the above example, the value 4 is returned by the 
+   * make up a <b>PShape</b>. In the above example, the value 4 is returned by the 
    * <b>getVertexCount()</b> method because 4 vertices are defined in 
    * <b>setup()</b>.
    * 
@@ -2274,7 +2274,7 @@ public int getVertexCount() {
 
 
   /**
-   * The <b>getVertex()</b> method returns a PVector with the coordinates of 
+   * The <b>getVertex()</b> method returns a <b>PVector</b> with the coordinates of 
    * the vertex point located at the position defined by the <b>index</b> 
    * parameter. This method works when shapes are created as shown in the 
    * example above, but won't work properly when a shape is defined explicitly 
@@ -3309,7 +3309,7 @@ public void scale(float x, float y, float z) {
 /**
    *
    * Replaces the current matrix of a shape with the identity matrix. The
-   * equivalent function in OpenGL is glLoadIdentity().
+   * equivalent function in OpenGL is <b>glLoadIdentity()</b>.
    *
    * @webref pshape:method
    * @webBrief Replaces the current matrix of a shape with the identity matrix