Improved documentation for GetProperty(), GetPropertyByName()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58973 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h
index ca8a678be9aadc470119f60827d8fed81689afa3..7694e80027349fe27cb38a4da0b9c5fe31e7ff06 100644 (file)
--- a/include/wx/propgrid/propgridiface.h
+++ b/include/wx/propgrid/propgridiface.h
@@ -352,14 +352,12 @@ public:
     }
 
     /**
-        Returns id of property with given name (case-sensitive).
+        Returns pointer to a property with given name (case-sensitive).
+        If there is no property with such name, @NULL pointer is returned.
 
-        If there is no property with such name, returned property id is invalid
-        ( i.e. it will return false with IsOk method).
-        @remarks
-        - Sub-properties (i.e. properties which have parent that is not
-          category or root) can not be accessed globally by their name.
-          Instead, use "<property>.<subproperty>" in place of "<subproperty>".
+        @remarks Properties which have non-category, non-root parent
+                 can not be accessed globally by their name. Instead, use
+                 "<property>.<subproperty>" instead of "<subproperty>".
     */
     wxPGProperty* GetProperty( const wxString& name ) const
     {

diff --git a/interface/wx/propgrid/propgridiface.h b/interface/wx/propgrid/propgridiface.h
index 83bc402577190ba694471f2e51874c92463e704a..4303403a131df87374a77944934ac626156e4193 100644 (file)
--- a/interface/wx/propgrid/propgridiface.h
+++ b/interface/wx/propgrid/propgridiface.h
@@ -245,7 +245,12 @@ public:
     wxPGProperty* GetFirst( int flags = wxPG_ITERATE_ALL );
 
     /**
-        Returns id of property with given name (case-sensitive).
+        Returns pointer to a property with given name (case-sensitive).
+        If there is no property with such name, @NULL pointer is returned.
+
+        @remarks Properties which have non-category, non-root parent
+                 can not be accessed globally by their name. Instead, use
+                 "<property>.<subproperty>" instead of "<subproperty>".
     */
     wxPGProperty* GetProperty( const wxString& name ) const;
 
@@ -296,7 +301,12 @@ public:
     wxPGProperty* GetPropertyByLabel( const wxString& label ) const;
 
     /**
-        Returns property with given name. @NULL if none found.
+        Returns pointer to a property with given name (case-sensitive).
+        If there is no property with such name, @NULL pointer is returned.
+
+        @remarks Properties which have non-category, non-root parent
+                 can not be accessed globally by their name. Instead, use
+                 "<property>.<subproperty>" instead of "<subproperty>".
     */
     wxPGProperty* GetPropertyByName( const wxString& name ) const;