From e3382b6e932e9425560573abd6e5a0b341937134 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 13 Dec 2020 00:18:27 +0100 Subject: [PATCH] Minor improvements to wxCredentialEntryDialog documentation Add Create() description and, more importantly, explain why could SetXXX() be useful. --- interface/wx/creddlg.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/interface/wx/creddlg.h b/interface/wx/creddlg.h index 9264fbda54..336caf9f2a 100644 --- a/interface/wx/creddlg.h +++ b/interface/wx/creddlg.h @@ -45,6 +45,8 @@ public: const wxString& password = ""); /** + Create the dialog constructed using the default constructor. + @param parent Parent window. @param message @@ -68,6 +70,10 @@ public: /** 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); @@ -78,6 +84,9 @@ public: /** Sets the current password. + + This function may be called before showing the dialog for the reasons + similar to SetUser(). */ void SetPassword(const wxString& password); };