From 384d9f9043669cd35504ba1204f07ea76ec4885c Mon Sep 17 00:00:00 2001 From: iwbnwif Date: Mon, 21 Aug 2017 22:54:21 +0100 Subject: [PATCH] Minor documentation changes for wxPersistentObject. --- interface/wx/persist.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/interface/wx/persist.h b/interface/wx/persist.h index a60fd1f42c..d703e720b0 100644 --- a/interface/wx/persist.h +++ b/interface/wx/persist.h @@ -292,13 +292,14 @@ protected: bool SaveValue(const wxString& name, T value) const; /** - Restore the value saved by Save(). + Restore a value saved by SaveValue(). @param name - The same name as was used by Save(). + The same name as was used by SaveValue(). @param value - Non-@NULL pointer which will be filled with the value if it was - read successfully or not modified if it wasn't. + Non-@NULL pointer to the same type that was passed to SaveValue(). + The pointed to object will be filled with the saved value if it + was read successfully or not modified otherwise. @return @true if the value was successfully read or @false if it was not found or an error occurred.