Improve dialogs_show_input() documentation.

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@5419 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Nick Treleaven 2010-11-18 18:53:12 +00:00
parent b9a42fa6d1
commit b846a54a3f

View File

@ -1035,8 +1035,9 @@ static void on_dialog_input(const gchar *str)
/** Asks the user for text input. /** Asks the user for text input.
* @param title Dialog title. * @param title Dialog title.
* @param parent The currently focused window, usually @c geany->main_widgets->window. * @param parent The currently focused window, usually @c geany->main_widgets->window.
* @param label_text Input label text. * @c NULL can be used but is discouraged due to window manager effects.
* @param default_text Text to display in the input. * @param label_text Label text, or @c NULL.
* @param default_text Text to display in the input field, or @c NULL.
* @return New copy of user input or @c NULL if cancelled. * @return New copy of user input or @c NULL if cancelled.
* @since 0.20. */ * @since 0.20. */
gchar *dialogs_show_input(const gchar *title, GtkWindow *parent, const gchar *label_text, gchar *dialogs_show_input(const gchar *title, GtkWindow *parent, const gchar *label_text,