From 66aa397b11533d36689d4d7b6ee4b1560a399e42 Mon Sep 17 00:00:00 2001 From: Thomas Bernard Date: Tue, 11 Dec 2018 12:24:43 +0100 Subject: [PATCH] Doxygen improvements --- src/const.h | 2 +- src/gfx2log.h | 1 + src/loadsave.h | 2 +- src/oldies.h | 2 ++ src/windows.h | 1 + 5 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/const.h b/src/const.h index 93e51270..303086cf 100644 --- a/src/const.h +++ b/src/const.h @@ -153,7 +153,7 @@ enum FILE_FORMATS FORMAT_FLI, ///< Autodesk Animator FLI/FLC FORMAT_MOTO, ///< Thomson MO/TO computers pictures FORMAT_HGR, ///< Apple II HGR and DHGR - FORMAT_MISC, ///< Must be last of enum: others formats recognized by SDL_image + FORMAT_MISC, ///< Must be last of enum: others formats recognized by SDL_image (or recoil) }; /// Default format for 'save as' diff --git a/src/gfx2log.h b/src/gfx2log.h index e4bf925d..89a25529 100644 --- a/src/gfx2log.h +++ b/src/gfx2log.h @@ -26,6 +26,7 @@ /** * @defgroup log error and debugging logs + * Functions to log error and debugging messages. * @{ */ diff --git a/src/loadsave.h b/src/loadsave.h index 76603710..0f64589f 100644 --- a/src/loadsave.h +++ b/src/loadsave.h @@ -168,7 +168,7 @@ void Delete_safety_backups(void); /// Data for an image file format. typedef struct { - byte Identifier; ///< Identifier for this format in enum :FILE_FORMATS + enum FILE_FORMATS Identifier; ///< Identifier for this format const char *Label; ///< Five-letter label Func_IO_Test Test; ///< Function which tests if the file is of this format Func_IO Load; ///< Function which loads an image of this format diff --git a/src/oldies.h b/src/oldies.h index 612fbf8e..66d76a95 100644 --- a/src/oldies.h +++ b/src/oldies.h @@ -194,6 +194,8 @@ int DECB_Check_binary_file(FILE * f); /** @}*/ /** @defgroup moto Thomson MO/TO + * Thomson MO/TO computer range + * * The Thomson MO/TO computer range was based on a Motorola 6809 CPU * and equiped with Microsoft Basic called Basic 1.0 for the first * versions and then Basic 128 or Basic 512 which included a DOS diff --git a/src/windows.h b/src/windows.h index 1ccae548..7c29581e 100644 --- a/src/windows.h +++ b/src/windows.h @@ -77,6 +77,7 @@ void Print_filename(void); void Print_counter(short x,short y,const char * str,byte text_color,byte background_color); /** @defgroup dialog Dialog windows + * Popups that show or ask an information to the user * @{ */ byte Confirmation_box(const char * message); void Warning_message(const char * message);