Java API: slight overhaul in preparation for the FP additions

Signed-off-by: Christoph M. Wintersteiger <cwinter@microsoft.com>

src/api/java/Global.java

@@ -19,16 +19,16 @@ package com.microsoft.z3;
 
 /**
  * Global functions for Z3. 
- * <remarks>
+ * Remarks: 
  * This (static) class contains functions that effect the behaviour of Z3
  * globally across contexts, etc. 
- * </remarks>
+ * 
  **/
 public final class Global
 {
     /**
      * Set a global (or module) parameter, which is shared by all Z3 contexts.
-     * <remarks>
+     * Remarks: 
      * When a Z3 module is initialized it will use the value of these parameters
      * when Z3_params objects are not provided.
      * The name of parameter can be composed of characters [a-z][A-Z], digits [0-9], '-' and '_'. 
@@ -36,11 +36,11 @@ public final class Global
      * The parameter names are case-insensitive. The character '-' should be viewed as an "alias" for '_'.
      * Thus, the following parameter names are considered equivalent: "pp.decimal-precision"  and "PP.DECIMAL_PRECISION".
      * This function can be used to set parameters for a specific Z3 module.
-     * This can be done by using <module-name>.<parameter-name>.
+     * This can be done by using &lt;module-name&gt;.&lt;parameter-name&gt;.
      * For example:
      * Z3_global_param_set('pp.decimal', 'true')
      * will set the parameter "decimal" in the module "pp" to true.
-     * </remarks>
+     * 
      **/
     public static void setParameter(String id, String value)
     {
@@ -49,11 +49,10 @@ public final class Global
     
     /**
      * Get a global (or module) parameter.     
-     * <remarks>               
-     * Returns null if the parameter <param name="id">parameter id</param> does not exist.     
+     * Remarks:     
      * This function cannot be invoked simultaneously from different threads without synchronization.
      * The result string stored in param_value is stored in a shared location.
-     * </remarks>
+     * @return null if the parameter {@code id} does not exist.
      **/
     public static String getParameter(String id)
     {
@@ -66,10 +65,9 @@ public final class Global
     
     /**
      * Restore the value of all global (and module) parameters.
-     * <remarks>
+     * Remarks: 
      * This command will not affect already created objects (such as tactics and solvers)
-     * </remarks>
-     * <seealso cref="SetParameter"/>
+	 * @see setParameter
      **/
     public static void resetParameters()
     {