Minor improvements to wxCredentialEntryDialog documentation

Add Create() description and, more importantly, explain why could
SetXXX() be useful.
This commit is contained in:
Vadim Zeitlin
2020-12-13 00:18:27 +01:00
parent 92dfef9083
commit e3382b6e93

View File

@@ -45,6 +45,8 @@ public:
const wxString& password = ""); const wxString& password = "");
/** /**
Create the dialog constructed using the default constructor.
@param parent @param parent
Parent window. Parent window.
@param message @param message
@@ -68,6 +70,10 @@ public:
/** /**
Sets the current user name. Sets the current user name.
This function may be called before showing the dialog to provide the
default value for the user name, if it's different from the one given
at the creation time.
*/ */
void SetUser(const wxString& user); void SetUser(const wxString& user);
@@ -78,6 +84,9 @@ public:
/** /**
Sets the current password. Sets the current password.
This function may be called before showing the dialog for the reasons
similar to SetUser().
*/ */
void SetPassword(const wxString& password); void SetPassword(const wxString& password);
}; };