m/grafX2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some doxygen warnings.

Browse Source 
git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@2117 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
Adrien Destugues
2015-04-04 09:08:11 +00:00
parent 11fa950ea7
commit 705584a9d7
8 changed files with 1511 additions and 949 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/brush.h
View File

@@ -110,16 +110,25 @@ void Nibble_brush(void);
void Capture_brush_with_lasso(int vertices, short * points,short clear);
///
/// Changes the Brush size.
/// @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).
/*!
\brief Allocates memory for a brush size change.
This function can return the old brush pixels which can then be used by the
caller to fill the new brush. Data is not automatically copied or converted
from the old brush to the new one here.
@param new_brush_width: new width of the brush
@param new_brush_height: new height of the brush
@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.