From: Jaakko Salli Date: Thu, 7 Jan 2010 19:43:12 +0000 (+0000) Subject: Improved documentation for wxPGProperty::DoSetAttribute() X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/14946ce13c15b729fb9e1f679e117a702db55861 Improved documentation for wxPGProperty::DoSetAttribute() git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63095 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/include/wx/propgrid/property.h b/include/wx/propgrid/property.h index e7c3930197..99027163b7 100644 --- a/include/wx/propgrid/property.h +++ b/include/wx/propgrid/property.h @@ -1456,12 +1456,16 @@ public: */ virtual void RefreshChildren(); - /** Special handling for attributes of this property. + /** + Reimplement this member function to add special handling for + attributes of this property. - If returns false, then the attribute will be automatically stored in - m_attributes. + @return Return @false to have the attribute automatically stored in + m_attributes. Default implementation simply does that and + nothing else. - Default implementation simply returns false. + @remarks To actually set property attribute values from the + application, use wxPGProperty::SetAttribute() instead. */ virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h index 280da6e128..95493ad7b4 100644 --- a/interface/wx/propgrid/property.h +++ b/interface/wx/propgrid/property.h @@ -881,12 +881,15 @@ public: virtual void RefreshChildren(); /** - Special handling for attributes of this property. + Reimplement this member function to add special handling for + attributes of this property. - If returns @false, then the attribute will be automatically stored in - m_attributes. + @return Return @false to have the attribute automatically stored in + m_attributes. Default implementation simply does that and + nothing else. - Default implementation simply returns @false. + @remarks To actually set property attribute values from the + application, use wxPGProperty::SetAttribute() instead. */ virtual bool DoSetAttribute( const wxString& name, wxVariant& value );