Code Documentation Question

@sploreg, You went to the trouble of creating a little diagram in the TerrainQuad Javadoc, which doesn’t show up in viewers, but only in the source code.



The fix to make it appear correctly is simple, but looks ugly as sin in IDE editors. The question is, where should it be expected to look nice? My personal vote is to fit it so that when folks see it on the web or in their editor of choice it makes sense…



[shell]


This patch file was generated by NetBeans IDE

It uses platform neutral UTF-8 encoding and n newlines.

— Base (BASE)

+++ Locally Modified (Based On LOCAL)

@@ -77,16 +77,16 @@

*

  • Heightmap coordinates start from the bottom left of the world and work towards the
  • top right.
    • <br>
    • <br> +x
    • <br> ^
    • <br> | …N = length of heightmap
    • <br> | :&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:
    • <br> | :&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:
    • <br> | 0…:
    • <br> +

> +z
+ * <br>(world coordinates)
*
- * +x
- * ^
- * | ......N = length of heightmap
- * | : :
- * | : :
- * | 0.....:
- * +
> +z
- * (world coordinates)
- *
* @author Brent Owens
*/
public class TerrainQuad extends Node implements Terrain {
[/shell]

What about pre tags?



You could also stick it in an {@code } block to make sure it was a fixed-width font and that greater than and less than signs make it through.



Something like:

[xml]

<pre>{@code

Insert formated stuff here.

}</pre>

[/xml]



Then it should look nice in both places.