From bd37af32b18d29bdbf5e893d07e817cf8a512dee Mon Sep 17 00:00:00 2001 From: PB Date: Sun, 21 Apr 2019 17:50:13 +0200 Subject: [PATCH] Improve documentation for file selector functions Improve wording, add missing parentheses to make a function reference hyperlinked, and add @header tag where it was missing. Closes https://github.com/wxWidgets/wxWidgets/pull/1303 --- interface/wx/filedlg.h | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/interface/wx/filedlg.h b/interface/wx/filedlg.h index 890491d112..719ac18b7c 100644 --- a/interface/wx/filedlg.h +++ b/interface/wx/filedlg.h @@ -399,7 +399,9 @@ wxString wxFileSelector(const wxString& message, int y = wxDefaultCoord); /** - An extended version of wxFileSelector + An extended version of wxFileSelector() + + @header{wx/filedlg.h} */ wxString wxFileSelectorEx(const wxString& message = wxFileSelectorPromptStr, const wxString& default_path = wxEmptyString, @@ -412,7 +414,11 @@ wxString wxFileSelectorEx(const wxString& message = wxFileSelectorPromptStr, int y = wxDefaultCoord); /** - Ask for filename to load + Shows a file dialog asking the user for a file name for opening a file. + + @see wxFileSelector(), wxFileDialog + + @header{wx/filedlg.h} */ wxString wxLoadFileSelector(const wxString& what, const wxString& extension, @@ -420,7 +426,11 @@ wxString wxLoadFileSelector(const wxString& what, wxWindow *parent = NULL); /** - Ask for filename to save + Shows a file dialog asking the user for a file name for saving a file. + + @see wxFileSelector(), wxFileDialog + + @header{wx/filedlg.h} */ wxString wxSaveFileSelector(const wxString& what, const wxString& extension,