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

Doxygen documentation for text.h, SFont.h, setup.h, realpath.h, readline.h, palette.h, keyboard.h, io.h, input.h, hotkeys.h, helpfile.h, errors.h; and a basic description for all other headers.

Browse Source 
Removed 2 unused function prototypes (They escaped translation)
In each C file, added a #include of its own header, to help doxygen generate a more complete documentation for the C files (and also double-check function prototypes)

All these changes don't change the generated executable, it's still beta 99.0.

git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@752 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
Yves Rizoud
2009-04-18 19:58:19 +00:00
parent 563b935615
commit c09f5819c2
50 changed files with 493 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
helpfile.h
View File

@@ -19,26 +19,38 @@
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#include "const.h" // Utilise les enumerations BOUTON_ et SPECIAL_
//////////////////////////////////////////////////////////////////////////////
///@file helpfile.h
/// This is all the text that appears in contextual help and credits.
///
/// Note: The source code is kept on a public website, so keep this in mind
/// if you're thinking of putting an e-mail address in there. At least, use
/// "\100" instead of @, to help against the most basic email address harversters.
//////////////////////////////////////////////////////////////////////////////
#include "const.h" // Uses enumerations BUTTON_NUMBERS and SPECIAL_ACTIONS
// Some magic formulas:
// Quelques formules magiques:
#define HELP_TEXT(x) {'N', x, 0},
// Génère une ligne 'N' (Normale)
// Generates a 'N' line (Normal)
#define HELP_LINK(x,y) {'K', x, y},
// Génère une ligne 'K' (Key)
// Generates a 'K' line (Key)
#define HELP_BOLD(x) {'S', x, 0},
// Génère une ligne 'S' (BOLD)
// Generates a 'S' line (BOLD)
#define HELP_TITLE(x) {'T', x, 0}, {'-', x, 0},
// Génère une ligne 'T' (Titre partie haute)
// et une deuxième '-' (Titre partie basse)
// (pour gérer les gros titres qui occupent deux lignes)
// Generates a 'T' line (Title, upper half)
// and a second '-' line (Title, lower half), with the same text.
static const T_Help_table helptable_about[] =
/*
Do not exceed 44 characters for normal lines:
HELP_TEXT ("--------------------------------------------")
Do not exceed 22 characters for title lines:
HELP_TITLE("======================")
*/
{
HELP_TEXT ("") // Laisse de la place pour le logo
@@ -2215,43 +2227,43 @@ T_Help_section Help_section[] =
HELP_TABLE_DECLARATION(helptable_help)
HELP_TABLE_DECLARATION(helptable_credits)
// Attention, dans l'ordre de BUTTON_NUMBERS
HELP_TABLE_DECLARATION(helptable_paintbrush )
HELP_TABLE_DECLARATION(helptable_adjust )
HELP_TABLE_DECLARATION(helptable_draw )
HELP_TABLE_DECLARATION(helptable_curves )
HELP_TABLE_DECLARATION(helptable_lines )
HELP_TABLE_DECLARATION(helptable_airbrush )
HELP_TABLE_DECLARATION(helptable_floodfill )
HELP_TABLE_DECLARATION(helptable_polygons )
HELP_TABLE_DECLARATION(helptable_polyfill )
HELP_TABLE_DECLARATION(helptable_rectangles )
HELP_TABLE_DECLARATION(helptable_filled_rectangles )
HELP_TABLE_DECLARATION(helptable_circles )
HELP_TABLE_DECLARATION(helptable_filled_circles )
HELP_TABLE_DECLARATION(helptable_grad_rect )
HELP_TABLE_DECLARATION(helptable_grad_menu )
HELP_TABLE_DECLARATION(helptable_spheres )
HELP_TABLE_DECLARATION(helptable_brush )
HELP_TABLE_DECLARATION(helptable_polybrush )
HELP_TABLE_DECLARATION(helptable_brush_fx )
HELP_TABLE_DECLARATION(helptable_effects )
HELP_TABLE_DECLARATION(helptable_text )
HELP_TABLE_DECLARATION(helptable_magnifier )
HELP_TABLE_DECLARATION(helptable_colorpicker )
HELP_TABLE_DECLARATION(helptable_resolution )
HELP_TABLE_DECLARATION(helptable_page )
HELP_TABLE_DECLARATION(helptable_save )
HELP_TABLE_DECLARATION(helptable_load )
HELP_TABLE_DECLARATION(helptable_settings )
HELP_TABLE_DECLARATION(helptable_clear )
HELP_TABLE_DECLARATION(helptable_general )
HELP_TABLE_DECLARATION(helptable_undo )
HELP_TABLE_DECLARATION(helptable_kill )
HELP_TABLE_DECLARATION(helptable_quit )
HELP_TABLE_DECLARATION(helptable_palette )
HELP_TABLE_DECLARATION(helptable_pal_scroll )
HELP_TABLE_DECLARATION(helptable_pal_scroll )
HELP_TABLE_DECLARATION(helptable_color_select )
HELP_TABLE_DECLARATION(helptable_hide )
// Attention, keep the same order as BUTTON_NUMBERS:
HELP_TABLE_DECLARATION(helptable_paintbrush)
HELP_TABLE_DECLARATION(helptable_adjust)
HELP_TABLE_DECLARATION(helptable_draw)
HELP_TABLE_DECLARATION(helptable_curves)
HELP_TABLE_DECLARATION(helptable_lines)
HELP_TABLE_DECLARATION(helptable_airbrush)
HELP_TABLE_DECLARATION(helptable_floodfill)
HELP_TABLE_DECLARATION(helptable_polygons)
HELP_TABLE_DECLARATION(helptable_polyfill)
HELP_TABLE_DECLARATION(helptable_rectangles)
HELP_TABLE_DECLARATION(helptable_filled_rectangles)
HELP_TABLE_DECLARATION(helptable_circles)
HELP_TABLE_DECLARATION(helptable_filled_circles)
HELP_TABLE_DECLARATION(helptable_grad_rect)
HELP_TABLE_DECLARATION(helptable_grad_menu)
HELP_TABLE_DECLARATION(helptable_spheres)
HELP_TABLE_DECLARATION(helptable_brush)
HELP_TABLE_DECLARATION(helptable_polybrush)
HELP_TABLE_DECLARATION(helptable_brush_fx)
HELP_TABLE_DECLARATION(helptable_effects)
HELP_TABLE_DECLARATION(helptable_text)
HELP_TABLE_DECLARATION(helptable_magnifier)
HELP_TABLE_DECLARATION(helptable_colorpicker)
HELP_TABLE_DECLARATION(helptable_resolution)
HELP_TABLE_DECLARATION(helptable_page)
HELP_TABLE_DECLARATION(helptable_save)
HELP_TABLE_DECLARATION(helptable_load)
HELP_TABLE_DECLARATION(helptable_settings)
HELP_TABLE_DECLARATION(helptable_clear)
HELP_TABLE_DECLARATION(helptable_general)
HELP_TABLE_DECLARATION(helptable_undo)
HELP_TABLE_DECLARATION(helptable_kill)
HELP_TABLE_DECLARATION(helptable_quit)
HELP_TABLE_DECLARATION(helptable_palette)
HELP_TABLE_DECLARATION(helptable_pal_scroll)
HELP_TABLE_DECLARATION(helptable_pal_scroll)
HELP_TABLE_DECLARATION(helptable_color_select)
HELP_TABLE_DECLARATION(helptable_hide)
};