diff options
author | Simon Howard | 2013-03-31 20:38:03 +0000 |
---|---|---|
committer | Simon Howard | 2013-03-31 20:38:03 +0000 |
commit | bd0f386997cccbeb41103d76f3dc6d9484800f0d (patch) | |
tree | 1e195c378f362be93c9aa30f7feceaa531e3a69c | |
parent | f346e3391d92036326ed100698e2a3ae6445fe16 (diff) | |
download | chocolate-doom-bd0f386997cccbeb41103d76f3dc6d9484800f0d.tar.gz chocolate-doom-bd0f386997cccbeb41103d76f3dc6d9484800f0d.tar.bz2 chocolate-doom-bd0f386997cccbeb41103d76f3dc6d9484800f0d.zip |
Fix Doxygen comments.
Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 2576
-rw-r--r-- | textscreen/txt_fileselect.h | 19 | ||||
-rw-r--r-- | textscreen/txt_widget.h | 1 |
2 files changed, 16 insertions, 4 deletions
diff --git a/textscreen/txt_fileselect.h b/textscreen/txt_fileselect.h index d591528e..dc65643d 100644 --- a/textscreen/txt_fileselect.h +++ b/textscreen/txt_fileselect.h @@ -27,6 +27,19 @@ #ifndef TXT_FILESELECT_H #define TXT_FILESELECT_H +/** + * @file txt_fileselect.h + * + * File selection widget. + */ + +/** + * File selection widget. + * + * A file selection widget resembles an input box (@ref txt_inputbox_t) + * but opens a file selector dialog box when clicked. + */ + typedef struct txt_fileselect_s txt_fileselect_t; /** @@ -39,14 +52,14 @@ int TXT_CanSelectFiles(void); /** * Open a native file selector to select a file. * - * @param title Pointer to a string containing a prompt to display + * @param prompt Pointer to a string containing a prompt to display * in the window. * @param extensions NULL-terminated list of filename extensions for * files that can be selected, or @ref TXT_DIRECTORY * to select directories. */ -char *TXT_SelectFile(char *window_title, char **extensions); +char *TXT_SelectFile(char *prompt, char **extensions); /** * Create a new txt_fileselect_t widget. @@ -54,7 +67,7 @@ char *TXT_SelectFile(char *window_title, char **extensions); * @param variable Pointer to a char * variable in which the selected * file should be stored. * @param size Width of the file selector widget in characters. - * @param title Pointer to a string containing a prompt to display + * @param prompt Pointer to a string containing a prompt to display * in the file selection window. * @param extensions NULL-terminated list of filename extensions that * can be used for this widget, or @ref TXT_DIRECTORY diff --git a/textscreen/txt_widget.h b/textscreen/txt_widget.h index f64b9517..3bde760d 100644 --- a/textscreen/txt_widget.h +++ b/textscreen/txt_widget.h @@ -168,7 +168,6 @@ int TXT_HoveringOverWidget(TXT_UNCAST_ARG(widget)); * whether it is selected and the mouse is hovering over it. * * @param widget The widget. - * @param selected Whether the widget is selected. */ void TXT_SetWidgetBG(TXT_UNCAST_ARG(widget)); |