Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation for file selector functions

Browse Source 
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
This commit is contained in:
PB
2019-04-21 17:50:13 +02:00
committed by Vadim Zeitlin
parent 21f6c0af1e
commit bd37af32b1
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
interface/wx/filedlg.h
View File

@@ -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,