From 13ff030393bfabfb08a23ed08f41a8dffc40adde Mon Sep 17 00:00:00 2001
From: gered <gered@blarg.ca>
Date: Wed, 12 Apr 2017 12:32:18 -0400
Subject: [PATCH] temporary fix for javadoc issues, will revisit later

---
 .../java/bwmirror/generator/java/Mirror.java  |  2 +-
 manual-bwapi-src/AbstractPoint.java           |  2 +-
 manual-bwapi-src/Color.java                   |  6 ----
 manual-bwapi-src/Mirror.java                  | 36 -------------------
 4 files changed, 2 insertions(+), 44 deletions(-)

diff --git a/generator/src/main/java/bwmirror/generator/java/Mirror.java b/generator/src/main/java/bwmirror/generator/java/Mirror.java
index 9793e44..1235387 100644
--- a/generator/src/main/java/bwmirror/generator/java/Mirror.java
+++ b/generator/src/main/java/bwmirror/generator/java/Mirror.java
@@ -16,7 +16,7 @@ import java.io.PrintStream;
  */
 public abstract class Mirror {
 
-    private static final boolean WRITE_DOC = true;
+    private static final boolean WRITE_DOC = false; // TODO: need to fix encoding / special character issues before we can leave enabled
 
     private static final boolean FORCE_WEB_DOCUMENTATION = true;
 
diff --git a/manual-bwapi-src/AbstractPoint.java b/manual-bwapi-src/AbstractPoint.java
index 067ca6c..548001d 100644
--- a/manual-bwapi-src/AbstractPoint.java
+++ b/manual-bwapi-src/AbstractPoint.java
@@ -4,7 +4,7 @@ package bwapi;
  * Common ancestor for location based objects to simplify distance computation.
  * This will be refactored into interface with default methods when java 8 becomes widely used.
  *
- * Idea by Rafa³ Poniatowski
+ * Idea by Rafa³ Poniatowski
  */
 public abstract class AbstractPoint<T extends AbstractPoint> {
 
diff --git a/manual-bwapi-src/Color.java b/manual-bwapi-src/Color.java
index ab029c8..713acd1 100644
--- a/manual-bwapi-src/Color.java
+++ b/manual-bwapi-src/Color.java
@@ -13,12 +13,6 @@ public class Color {
 
     private int r, g, b;
 
-    /**
-     * Create a color using the color in the palette that is closest to the RGB color specified. This will check a number of colors in the pallet to see which is closest to the specified color so this function is relatively slow.
-     * @param r
-     * @param g
-     * @param b
-     */
     public Color(int r, int g, int b) {
         this.r = r;
         this.g = g;
diff --git a/manual-bwapi-src/Mirror.java b/manual-bwapi-src/Mirror.java
index 78296b1..b311b5a 100644
--- a/manual-bwapi-src/Mirror.java
+++ b/manual-bwapi-src/Mirror.java
@@ -11,42 +11,6 @@ import java.util.*;
 import java.util.regex.Pattern;
 import java.util.zip.*;
 
-/**
- * <p>The API entry point. Standard use case:</p>
- * <ul>
- *     <li>Create a Mirror object and use {@link #getModule()} and then set an {@link AIModule}'s {@link BWEventListener}<br/>
- *     <li>Call {@link #startGame()} to init the API and connect to Broodwar, then launch Broodwar from ChaosLauncher.</li>
- *     <li>In you {@link BWEventListener#onStart()} method, receive the Game object by calling {@link #getGame()}</li>
- * </ul>
- * <br/>
- * <b>Example</b>
- * <pre>
- *     {@code
- *
- *     mirror.getModule().setEventListener(new DefaultBWListener()
- *     {
- *            public void onStart() {
- *                game = mirror.getGame();
- *                self = game.self();
- *                //initialization
- *                ....
- *            }
- *
- *           public void onUpdate() {
- *               for (Unit myUnit : self.getUnits()) {
- *                   //give orders to unit
- *                   ...
- *                }
- *           }
- *        });
- *     }
- *     mirror.startGame();
- * </pre>
-
- * <p><b>Note:</b> The Game object is initialized during the {@link #startGame()} as well as other BWMirror API's constants.
- * Do not use any API releated methods/fields prior to {@link #startGame()}.</p>
-
- */
 public class Mirror {
 
     private Game game;