More plotters commenting. Text and bitmap plotters.

svn path=/trunk/netsurf/; revision=6594

1 files changed, 17 insertions, 4 deletions

diff --git a/desktop/plotters.h b/desktop/plotters.h
index 2a6cf77bc..4eb894981 100644
--- a/desktop/plotters.h
+++ b/desktop/plotters.h
@@ -48,10 +48,23 @@ struct bitmap;
  *  rectangle	- Plots a rectangle outline. The line can be solid, dotted or
  *		  dashed.
  *  fill	- Plots a filled rectangle.
- *  clip	-
- *  text	-
- *  bitmap	-
- *  bitmap_tile	-
+ *  clip	- Sets a clip rectangle for subsequent plots.
+ *  text	- Plots text. (x,y) is the coordinate of the left hand side of
+ *		  the text's baseline. The text is UTF-8 encoded. The colour, c,
+ *		  is the colour of the text. Background colour, bg, may be used
+ *		  optionally to attempt to provide anti-aliased text without
+ *		  screen reads. Font information is provided in the style.
+ *  bitmap	- Plots a bitmap image. (x,y) is the coordinate of the top
+ *		  left of the image. Width and height give the dimensions the
+ *		  image is to be plotted to. (Will be different to the image's
+ *		  intrinsic width and height if the image is to be scaled.)
+ *  bitmap_tile	- Tiled plot of a bitmap image. (x,y) gives the top left
+ *		  coordinate of an explicitly placed tile. From this tile the
+ *		  image can repeat in all four directions -- up, down, left and
+ *		  right -- to the extents given by the current clip rectangle.
+ *		  If repeat_x is true, the image is tiled in the x-dimension,
+ *		  otherwise it is not. If repeat_y is true, the image is tiled
+ *		  in the y-dimension, otherwise it is not.
  *  group_start	- Start of a group of objects. Used when plotter implements
  *		  export to a vector graphics file format. (Optional.)
  *  group_end	- End of the most recently started group. (Optional.)