Updated descriptions in comments for processing core and libraries

Author: Anadroid

core/src/processing/core/PApplet.java

@@ -127,41 +127,42 @@ public interface PConstants {
 
   // useful goodness
 
-  /**
-   *
-   * PI is a mathematical constant with the value 3.14159265358979323846. It
-   * is the ratio of the circumference of a circle to its diameter. It is
-   * useful in combination with the trigonometric functions <b>sin()</b> and
-   * <b>cos()</b>.
-   *
-   * @webref constants
-   * @webBrief PI is a mathematical constant with the value 3.14159265358979323846.
-   * @see PConstants#TWO_PI
-   * @see PConstants#TAU
-   * @see PConstants#HALF_PI
-   * @see PConstants#QUARTER_PI
-   *
-   */
+  	/**
+	 *
+	 * <b>PI</b> is a mathematical constant with the value 3.1415927. It is the
+	 * ratio of the circumference of a circle to its diameter. It is useful in
+	 * combination with the trigonometric functions <b>sin()</b> and <b>cos()</b>.
+	 *
+	 * @webref constants
+	 * @webBrief PI is a mathematical constant with the value
+	 *           3.14159265358979323846.
+	 * @see PConstants#TWO_PI
+	 * @see PConstants#TAU
+	 * @see PConstants#HALF_PI
+	 * @see PConstants#QUARTER_PI
+	 *
+	 */
   static final float PI = (float) Math.PI;
-  /**
-   *
-   * HALF_PI is a mathematical constant with the value
-   * 1.57079632679489661923. It is half the ratio of the circumference of a
-   * circle to its diameter. It is useful in combination with the
-   * trigonometric functions <b>sin()</b> and <b>cos()</b>.
-   *
-   * @webref constants
-   * @webBrief HALF_PI is a mathematical constant with the value 1.57079632679489661923.
-   * @see PConstants#PI
-   * @see PConstants#TWO_PI
-   * @see PConstants#TAU
-   * @see PConstants#QUARTER_PI
-   */
+  	/**
+	 *
+	 * <b>HALF_PI</b> is a mathematical constant with the value 1.5707964. It is
+	 * half the ratio of the circumference of a circle to its diameter. It is useful
+	 * in combination with the trigonometric functions <b>sin()</b> and
+	 * <b>cos()</b>.
+	 *
+	 * @webref constants
+	 * @webBrief HALF_PI is a mathematical constant with the value
+	 *           1.57079632679489661923.
+	 * @see PConstants#PI
+	 * @see PConstants#TWO_PI
+	 * @see PConstants#TAU
+	 * @see PConstants#QUARTER_PI
+	 */
   static final float HALF_PI = (float) (Math.PI / 2.0);
   static final float THIRD_PI = (float) (Math.PI / 3.0);
   /**
    *
-   * QUARTER_PI is a mathematical constant with the value 0.7853982. It is
+   * <b>QUARTER_PI</b> is a mathematical constant with the value 0.7853982. It is
    * one quarter the ratio of the circumference of a circle to its diameter.
    * It is useful in combination with the trigonometric functions
    * <b>sin()</b> and <b>cos()</b>.
@@ -176,7 +177,7 @@ public interface PConstants {
   static final float QUARTER_PI = (float) (Math.PI / 4.0);
   /**
    *
-   * TWO_PI is a mathematical constant with the value 6.28318530717958647693.
+   * <b>TWO_PI</b> is a mathematical constant with the value 6.2831855.
    * It is twice the ratio of the circumference of a circle to its diameter.
    * It is useful in combination with the trigonometric functions
    * <b>sin()</b> and <b>cos()</b>.
@@ -189,20 +190,21 @@ public interface PConstants {
    * @see PConstants#QUARTER_PI
    */
   static final float TWO_PI = (float) (2.0 * Math.PI);
-  /**
-   *
-   * TAU is an alias for TWO_PI, a mathematical constant with the value
-   * 6.28318530717958647693. It is twice the ratio of the circumference
-   * of a circle to its diameter. It is useful in combination with the
-   * trigonometric functions <b>sin()</b> and <b>cos()</b>.
-   *
-   * @webref constants
-   * @webBrief An alias for TWO_PI
-   * @see PConstants#PI
-   * @see PConstants#TWO_PI
-   * @see PConstants#HALF_PI
-   * @see PConstants#QUARTER_PI
-   */
+  	/**
+	 *
+	 * <b>TAU</b> is a mathematical constant with the value 6.2831855. It is the
+	 * circle constant relating the circumference of a circle to its linear
+	 * dimension, the ratio of the circumference of a circle to its radius. It is
+	 * useful in combination with trigonometric functions such as <b>sin()</b> and
+	 * <b>cos()</b>.
+	 *
+	 * @webref constants
+	 * @webBrief An alias for TWO_PI
+	 * @see PConstants#PI
+	 * @see PConstants#TWO_PI
+	 * @see PConstants#HALF_PI
+	 * @see PConstants#QUARTER_PI
+	 */
   static final float TAU = (float) (2.0 * Math.PI);
 
   static final float DEG_TO_RAD = PI/180.0f;

core/src/processing/core/PConstants.java

@@ -35,9 +35,23 @@
 
 
 /**
- * Grayscale bitmap font class used by Processing.
+ * PFont is the font class for Processing. To create a font to use with
+ * Processing, select "Create Font..." from the Tools menu. This will create a
+ * font in the format Processing requires and also adds it to the current
+ * sketch's data directory. Processing displays fonts using the .vlw font
+ * format, which uses images for each letter, rather than defining them through
+ * vector data. The <b>loadFont()</b> function constructs a new font and
+ * <b>textFont()</b> makes a font active. The <b>list()</b> method creates a
+ * list of the fonts installed on the computer, which is useful information to
+ * use with the <b>createFont()</b> function for dynamically converting fonts
+ * into a format to use with Processing.<br />
+ * <br />
+ * To create a new font dynamically, use the <b>createFont()</b> function. Do
+ * not use the syntax <b>new PFont()</b>.
+ * 
  * <P>
  * Awful (and by that, I mean awesome) ASCII (non-)art for how this works:
+ * 
  * <PRE>
  *   |
  *   |                   height is the full used height of the image
@@ -55,6 +69,7 @@
  *
  *   ^^^^^^^^^^^^^^ setWidth (width displaced by char)
  * </PRE>
+ * 
  * @webref typography
  * @webBrief Grayscale bitmap font class used by Processing.
  * @see PApplet#loadFont(String)
@@ -869,20 +884,18 @@ public PShape getShape(char ch, float detail) {
   }
 
 
-  /**
-   *
-   * Gets a list of the fonts installed on the system. The data is returned
-   * as a String array. This list provides the names of each font for input
-   * into <b>createFont()</b>, which allows Processing to dynamically format
-   * fonts. This function is meant as a tool for programming local
-   * applications and is not recommended for use in applets.
-   *
-   *
-   * @webref pfont
-   * @webBrief Gets a list of the fonts installed on the system.
-   * @usage application
-   * @brief     Gets a list of the fonts installed on the system
-   */
+  	/**
+	 *
+	 * Gets a list of the fonts installed on the system. The data is returned as a
+	 * String array. This list provides the names of each font for input into
+	 * <b>createFont()</b>, which allows Processing to dynamically format fonts.
+	 *
+	 *
+	 * @webref pfont
+	 * @webBrief Gets a list of the fonts installed on the system.
+	 * @usage application
+	 * @brief Gets a list of the fonts installed on the system
+	 */
   static public String[] list() {
     loadFonts();
     String[] list = new String[fonts.length];