Fix some doxygen warnings.

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

src/brush.c

@@ -602,14 +602,7 @@ void Draw_paintbrush(short x,short y,byte color)
   }
 }
 
-/// @return 0 on success, non-zero on failure (memory?).
+
-/// @param new_brush: Optionally, you can provide an already allocated new
-///        brush - otherwise, this function performs the allocation.
-/// @param old_brush: If the caller passes NULL, this function will free the old
-///        pixel data. If the caller provides the address of a (free) byte
-///        pointer, the function will make it point to the original pixel data,
-///        in this case it will be the caller's responsibility to free() it
-///        (after transferring pixels to Brush, usually).
 byte Realloc_brush(word new_brush_width, word new_brush_height, byte *new_brush, byte **old_brush)
 {
 

src/brush.h

@@ -110,16 +110,25 @@ void Nibble_brush(void);
 void Capture_brush_with_lasso(int vertices, short * points,short clear);
 
 
-///
+/*!
-/// Changes the Brush size.
+ \brief Allocates memory for a brush size change.
-/// @return 0 on success, non-zero on failure (memory?).
+
-/// @param new_brush: Optionally, you can provide an already allocated new
+ This function can return the old brush pixels which can then be used by the
-///        brush - otherwise, this function performs the allocation.
+ caller to fill the new brush. Data is not automatically copied or converted
-/// @param old_brush: If the caller passes NULL, this function will free the old
+ from the old brush to the new one here.
-///        pixel data. If the caller provides the address of a (free) byte
+
-///        pointer, the function will make it point to the original pixel data,
+ @param new_brush_width: new width of the brush
-///        in this case it will be the caller's responsibility to free() it
+ @param new_brush_height: new height of the brush
-///        (after transferring pixels to Brush, usually).
+ @param new_brush: Optionally, you can provide an already allocated new
+        brush - otherwise, this function performs the allocation.
+ @param old_brush: If the caller passes NULL, this function will free the old
+        pixel data. If the caller provides the address of a (free) byte
+        pointer, the function will make it point to the original pixel data,
+        in this case it will be the caller's responsibility to free() it
+        (after transferring pixels to Brush, usually).
+
+ @return 0 on success, non-zero when running out of memory.
+*/
 byte Realloc_brush(word new_brush_width, word new_brush_height, byte *new_brush, byte **old_brush);
 
 /// Sets brush's original palette and color mapping.

src/global.h

@@ -149,7 +149,7 @@ GFX2_GLOBAL byte  Paintbrush_shape;
 GFX2_GLOBAL byte  Paintbrush_shape_before_fill;
 /// Backup of ::Paintbrush_shape, before color picker operation
 GFX2_GLOBAL byte  Paintbrush_shape_before_colorpicker;
-/// Backup of ::Paintbrush_shaper, before lasso operation
+/// Backup of ::Paintbrush_shape, before lasso operation
 GFX2_GLOBAL byte  Paintbrush_shape_before_lasso;
 /// Boolean, true when the preview paintbrush shouldn't be drawn.
 GFX2_GLOBAL byte  Paintbrush_hidden;
@@ -699,7 +699,7 @@ GFX2_GLOBAL Func_gradient Gradient_function;
 /// either ::Pixel (if the gradient must be drawn on menus only)
 /// or ::Display_pixel (if the gradient must be drawn on the image)
 GFX2_GLOBAL Func_pixel Gradient_pixel;
-/// Index in ::Gradient_array of the currently selected gradient.
+/// Index in ::T_Page::Gradient_array of the currently selected gradient.
 GFX2_GLOBAL byte Current_gradient;
 /// Boolean, true when the color cycling is active.
 GFX2_GLOBAL byte Cycling_mode;
@@ -735,7 +735,7 @@ GFX2_GLOBAL byte Back_color;
 GFX2_GLOBAL byte Selected_freehand_mode;
 /// For the Curve tool, this determines which variant is selected, either ::OPERATION_3_POINTS_CURVE or ::OPERATION_4_POINTS_CURVE
 GFX2_GLOBAL byte Selected_curve_mode;
-/// For the Line tool, this determines which variant is selected, either ::OPERATION_LINE, ::OPERATION_K_LIGNE or ::OPERATION_CENTERED_LINES
+/// For the Line tool, this determines which variant is selected, either ::OPERATION_LINE, ::OPERATION_K_LINE or ::OPERATION_CENTERED_LINES
 GFX2_GLOBAL byte Selected_line_mode;
 /// Determines which color appears in the first cell of the menu palette. Change this value to "scroll" the palette.
 GFX2_GLOBAL byte First_color_in_palette;

src/io.h

@@ -120,6 +120,6 @@ void Append_path(char *path, const char *filename, char *reverse_path);
 byte Create_lock_file(const char *file_directory);
 
 ///
-/// Release a lock file created by ::Create_Lock_file
+/// Release a lock file created by ::Create_lock_file
 void Release_lock_file(const char *file_directory);
 

src/keyboard.h

@@ -33,7 +33,7 @@
 /// - 0x0000 + SDLK_LAST+4+B : Joystick button number "B", starting at B=0.
 /// - 0x0800 + a number between 0 and 0x7FF: The scancode key number, for keys which have no "sym", such as keys from multimedia keyboards, and "fn" and "Thinkpad" key for a laptop.
 /// Add 0x1000 for the Shift modifier MOD_SHIFT
-/// Add 0x2000 for the Control modifier ::MOD_CONTROL
+/// Add 0x2000 for the Control modifier ::MOD_CTRL
 /// Add 0x4000 for the Alt modifier ::MOD_ALT
 /// Add 0x8000 for the "Meta" modifier ::MOD_META (On MacOS X it's the CMD key)
 //////////////////////////////////////////////////////////////////////////////
@@ -64,13 +64,13 @@ word Key_for_scancode(word scancode);
 
 /*!
     Returns key name in a string. Used to display them in the helpscreens and in the keymapper window.
-  @param Key keycode of the key to translate, including modifiers
+  @param key keycode of the key to translate, including modifiers
 */
 const char * Key_name(word key);
 
 /*!
   Gets the modifiers in our format from the SDL_Mod information.
-  Returns a combination of ::MOD_SHIFT, ::MOD_ALT, ::MOD_CONTROL
+  Returns a combination of ::MOD_SHIFT, ::MOD_ALT, ::MOD_CTRL
   @param mod SDL modifiers state
 */
 word Key_modifiers(SDLMod mod);

src/operatio.h

@@ -138,7 +138,7 @@ void Colorpicker_1_1(void);
 void Colorpicker_2_1(void);
 void Colorpicker_0_1(void);
 
-/////////////////////////////////////////////////////////// OPERATION_K_LIGNE
+/////////////////////////////////////////////////////////// OPERATION_K_LINE
 
 void K_line_12_0(void);
 void K_line_12_6(void);

src/struct.h

@@ -526,9 +526,9 @@ typedef struct {
   word  Height;
   /// Type of the preset paintbrush: index in enum PAINTBRUSH_SHAPES
   byte  Shape;
-  /// Brush handle for the preset brushes. Generally ::Width[]/2
+  /// Brush handle for the preset brushes. Generally ::T_Paintbrush::Width[]/2
   word  Offset_X;
-  /// Brush handle for the preset brushes. Generally ::Height[]/2
+  /// Brush handle for the preset brushes. Generally ::T_Paintbrush::Height[]/2
   word  Offset_Y;
 
 } T_Paintbrush;