-Some doxygening

-Removed useless parts of the doxyfile and enabled DOT to generate callgraph and includegraphs. Use \callgraph or \callergraph where you think it'd be nice to have.
-Replaced Num2str with a call to sprintf. Less code is better !


git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@1165 416bcca6-2ee7-4201-b75f-2eb2f807beb1

struct.h

@@ -52,14 +52,15 @@
 #define qword uint64_t
 
 // Named function prototypes
-typedef void (* Func_action)    (void);
-typedef void (* Func_pixel) (word,word,byte);
-typedef byte (* Func_read)   (word,word);
+// GrafX2 use a lot of function pointer to do the drawing depending in the "fake hardware zoom" and the magnifier status.
+typedef void (* Func_action)    (void); ///< An action. Used when you click a menu button or trigger a keyboard shortcut.
+typedef void (* Func_pixel) (word,word,byte); ///< Set pixel at position (x,y) to color c. Used in load screen to write the data to brush, picture, or preview area.
+typedef byte (* Func_read)   (word,word); ///< Read a pixel at position (x,y) on something. Used for example in save to tell if the data is a brush or a picture
 typedef void (* Func_clear)  (byte);
 typedef void (* Func_display)   (word,word,word);
-typedef byte (* Func_effect)     (word,word,byte);
+typedef byte (* Func_effect)     (word,word,byte); ///< Called by all drawing tools to draw with a special effect (smooth, transparency, shade, ...)
 typedef void (* Func_block)     (word,word,word,word,byte);
-typedef void (* Func_line_XOR) (word,word,word);
+typedef void (* Func_line_XOR) (word,word,word); ///< Draw an XOR line on the picture view of the screen. Use a different function when in magnify mode.
 typedef void (* Func_display_brush_color) (word,word,word,word,word,word,byte,word);
 typedef void (* Func_display_brush_mono)  (word,word,word,word,word,word,byte,byte,word);
 typedef void (* Func_gradient)   (long,short,short);
@@ -69,7 +70,7 @@ typedef void (* Func_display_zoom) (word,word,word,byte *);
 typedef void (* Func_display_brush_color_zoom) (word,word,word,word,word,word,byte,word,byte *);
 typedef void (* Func_display_brush_mono_zoom)  (word,word,word,word,word,word,byte,byte,word,byte *);
 typedef void (* Func_draw_brush) (byte *,word,word,word,word,word,word,byte,word);
-typedef void (* Func_draw_list_item) (word,word,word,byte);
+typedef void (* Func_draw_list_item) (word,word,word,byte); ///< Draw an item inside a list button. This is done with a callback so it is possible to draw anything, as the list itself doesn't handle the content
 
 /// A set of RGB values.
 #pragma pack(1)
@@ -118,7 +119,7 @@ typedef struct T_Scroller_button
   struct T_Scroller_button * Next;///< Pointer to the next scroller of current window.
 } T_Scroller_button;
 
-///
+/// Special invisible button
 /// A window control that only has a rectangular "active" area which catches mouse clicks,
 // but no visible shape. It's used for custom controls where the drawing is done on
 // a case by case basis.
@@ -183,6 +184,8 @@ typedef struct T_Fileselector
   T_Fileselector_item ** Index;
 } T_Fileselector;
 
+/// "List" button as used in the font selection, skin selection, and brush factory screens. It's like a limited filelist.
+/// The screenmode selection and load/save screen were written before this existed so they use their own code. It would be nice if they were updated to use this one.
 typedef struct T_List_button
 {
   short Number;                     ///< Unique identifier for all controls
@@ -327,6 +330,9 @@ typedef struct
 // backup dans "graph.c".
 
 /// This is the data for one step of Undo/Redo, for one image.
+/// This structure is resized dynamically to hold pointers to all of the layers in the picture.
+/// The pointed layers are just byte* holding the raw pixel data. But at Image[0]-1 you will find a short that is used as a reference counter for each layer.
+/// This way we can use the same pixel data in many undo pages when the user edit only one of the layers (which is what they usually do).
 typedef struct T_Page
 {
   int       Width;   ///< Image width in pixels.
@@ -354,6 +360,7 @@ typedef struct
 } T_List_of_pages;
 
 /// A single image bitmap
+/// This struct is used to store a flattened view of the current picture.
 typedef struct
 {
   int       Width;   ///< Image width in pixels.