search

yellowstonegames / SquidLib

Useful tools for roguelike, role-playing, strategy, and other grid-based games in Java. Feedback is welcome!
Other
448 stars 46 forks source link

CW and DB colors missing @ colorization in javadoc #182

Closed SquidPony closed 6 years ago

SquidPony commented 6 years ago

The @ symbol in the middle three blocks should be the color of the Color

Example where it's the Color

    /**
     * Color constant<PRE>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ff0000; color: #000000'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #888888; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #ffffff; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #ff0000; color: #888888'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ff0000; color: #ffffff'>&nbsp;@&nbsp;</font>
     * <p>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font>
     * <font style='background-color: #ff0000; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #ffff00; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #00ff00; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #0000ff; color: #ff0000'>&nbsp;@&nbsp;</font><font style='background-color: #964b00; color: #ff0000'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font></PRE>
     */
    public static final SColor RED = new SColor(0xff0000, "Red");

Example where it's black instead:

    /**
     * Color constant<PRE>
     * <font style='background-color: #ee2a2a; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ee2a2a; color: #000000'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ee2a2a; color: #ee2a2a'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000;'>&nbsp;@&nbsp;</font><font style='background-color: #888888;'>&nbsp;@&nbsp;</font><font style='background-color: #ffffff;'>&nbsp;@&nbsp;</font><font style='background-color: #ee2a2a; color: #888888'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ee2a2a; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ee2a2a; color: #ffffff'>&nbsp;@&nbsp;</font>
     * <br>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font>
     * <font style='background-color: #ff0000; color: #ee2a2a'>&nbsp;@&nbsp;</font><font style='background-color: #ffff00;'>&nbsp;@&nbsp;</font><font style='background-color: #00ff00;'>&nbsp;@&nbsp;</font><font style='background-color: #0000ff;'>&nbsp;@&nbsp;</font><font style='background-color: #964b00;'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font></PRE>
     */
    public static final SColor CW_RED = new SColor(0xee2a2a, "CW Red");
tommyettinger commented 6 years ago

On it! I have a test that generates the documented color code, it probably just needs to be updated.

tommyettinger commented 6 years ago

Old RED_BEAN color:

    /**
     * Color constant<PRE>
     * <font style='background-color: #672422; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #672422; color: #000000'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #672422; color: #672422'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000;'>&nbsp;@&nbsp;</font><font style='background-color: #888888;'>&nbsp;@&nbsp;</font><font style='background-color: #ffffff;'>&nbsp;@&nbsp;</font><font style='background-color: #672422; color: #888888'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #672422; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #672422; color: #ffffff'>&nbsp;@&nbsp;</font>
     * <p>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font>
     * <font style='background-color: #ff0000; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #ffff00;'>&nbsp;@&nbsp;</font><font style='background-color: #00ff00;'>&nbsp;@&nbsp;</font><font style='background-color: #0000ff;'>&nbsp;@&nbsp;</font><font style='background-color: #964b00;'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font></PRE>
     */
    public static final SColor RED_BEAN = new SColor(0x672422, "Red Bean");

New RED_BEAN color:

    /**
     * This color constant "Red Bean" has RGB code 0x672422, hue 0.0048309565, saturation 0.66990286, and value 0.40392157.
     * <pre>
     * <font style='background-color: #672422; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #672422; color: #000000'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #672422; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #888888; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #ffffff; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #672422; color: #888888'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #672422; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #000000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #888888; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffffff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #672422; color: #ffffff'>&nbsp;@&nbsp;</font>
     * <br>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font>
     * <font style='background-color: #ff0000; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #ffff00; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #00ff00; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #0000ff; color: #672422'>&nbsp;@&nbsp;</font><font style='background-color: #964b00; color: #672422'>&nbsp;@&nbsp;</font>
     * <font style='background-color: #ff0000; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #ffff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #00ff00; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #0000ff; color: #000000'>&nbsp;&nbsp;&nbsp;</font><font style='background-color: #964b00; color: #000000'>&nbsp;&nbsp;&nbsp;</font></pre>
     */
    public static final SColor RED_BEAN = new SColor(0x672422, "Red Bean");

A bit more useful information, right?

SquidPony commented 6 years ago

nice!