Added doxygen documentation. Now we have to update the comments in all the files. See aide.h and button.h for some examples. Documentation is regenerated by "doxygen Doxyfile" in the root directory
git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@665 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
24
aide.h
24
aide.h
@@ -18,6 +18,28 @@
|
||||
write to the Free Software Foundation, Inc.,
|
||||
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
*/
|
||||
|
||||
#ifndef __AIDE_H_
|
||||
#define __AIDE_H_
|
||||
|
||||
/*!
|
||||
Called to open the help window with the keyboard shortcut.
|
||||
If the mouse is over a button, its contextual help will be displayed.
|
||||
Else, the default helpscreen will be shown.
|
||||
*/
|
||||
void Bouton_Aide(void);
|
||||
|
||||
/*!
|
||||
Displays and runs the "Statistics" window
|
||||
*/
|
||||
void Bouton_Stats(void);
|
||||
void Fenetre_aide(int, const char *);
|
||||
|
||||
/*!
|
||||
Displays and runs the "Help / About..." window
|
||||
@param Section Number of the help section page to display (equals the button number the mouse was hovering for the contextual help), -1 for the main help page.
|
||||
@param Sous_section Help sub-section title (the page will be scrolled so this title is at the top).
|
||||
*/
|
||||
void Fenetre_aide(int Section, const char * Sous_section);
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
Reference in New Issue
Block a user