Update wxPropertyGrid documentation

Completed documentation for topics marked as uncompleted.

include/wx/propgrid/propgriddefs.h

@@ -348,6 +348,7 @@ enum wxPG_MISC_ARG_FLAGS
     // Get/Store full value instead of displayed value.
     wxPG_FULL_VALUE                     = 0x00000001,
 
+    // Perform special action in case of unsuccessful conversion.
     wxPG_REPORT_ERROR                   = 0x00000002,
 
     wxPG_PROPERTY_SPECIFIC              = 0x00000004,

include/wx/propgrid/propgridiface.h

@@ -513,7 +513,7 @@ public:
     // category will be its own wxVariantList of wxVariant.
     // Use wxPG_INC_ATTRIBUTES to include property attributes as well.
     // Each attribute will be stored as list variant named
-    // "@@<propname>@@attr."
+    // "@<propname>@attr."
     wxVariant GetPropertyValues( const wxString& listname = wxEmptyString,
         wxPGProperty* baseparent = NULL, long flags = 0 ) const
     {

interface/wx/propgrid/editors.h

@@ -120,7 +120,7 @@ public:
         wxWindow* wnd_primary, wxEvent& event ) const = 0;
 
     /**
-        Returns value from control, via parameter 'variant'.
+        Returns value from control, via parameter @a variant.
         Usually ends up calling property's StringToValue() or IntToValue().
         Returns @true if value was different.
     */

interface/wx/propgrid/property.h

@@ -971,7 +971,14 @@ public:
         @param text
             String to get the value from.
         @param flags
-            @todo docme
+            If @c wxPG_FULL_VALUE is set, the function sets complete, storable
+            value instead of displayable one (they may be different).
+            @c wxPG_PROGRAMMATIC_VALUE flag is used to indicate that value is
+            being set programmatically (i.e. operation is not caused by user
+            input).
+            If @c wxPG_REPORT_ERROR is set, a special action should be
+            performed if string couldn't have been successfully converted
+            to the valid value (e.g. a special value can be set in this case).
 
         @return @true if value was changed.
     */

interface/wx/propgrid/propgridiface.h

@@ -376,21 +376,23 @@ public:
 
         @remarks Properties which have non-category, non-root parent
                  cannot be accessed globally by their name. Instead, use
-                 "<property>.<subproperty>" instead of "<subproperty>".
+                 @"@<property@>.@<subproperty@>@" instead of @"@<subproperty@>@".
     */
     wxPGProperty* GetProperty( const wxString& name ) const;
 
     /**
-        Adds to 'targetArr' pointers to properties that have given flags 'flags' set.
+        Adds to @a targetArr pointers to properties that have given @a flags set.
-        However, if @a 'inverse' is set to @true, then only properties without
+        However, if @a inverse is set to @true, then only properties without
         given flags are stored.
 
         @param targetArr
-            @todo docme
+            Array of pointers to properties in which found properties are
+            stored.
         @param flags
             Property flags to use.
         @param inverse
-            @todo docme
+            If @false, properties that have given flags are stored, otherwise
+            there are stored only properties without given flags.
         @param iterFlags
             Iterator flags to use. Default is everything expect private children.
             See @ref propgrid_iterator_flags.
@@ -446,8 +448,8 @@ public:
     wxPGProperty* GetPropertyByName( const wxString& name ) const;
 
     /**
-        Returns child property 'subname' of property 'name'. Same as
+        Returns child property @a subname of property @a name. Same as
-        calling GetPropertyByName("name.subname"), albeit slightly faster.
+        calling GetPropertyByName(@"name.subname@"), albeit slightly faster.
     */
     wxPGProperty* GetPropertyByName( const wxString& name,
                                      const wxString& subname ) const;
@@ -542,16 +544,16 @@ public:
         property values. Order is not guaranteed.
 
         @param listname
-            @todo docme
+            Name of the returned wxVariant list.
         @param baseparent
-            @todo docme
+            The base property which children properties will be queried for
+            values.
         @param flags
-            Use wxPG_KEEP_STRUCTURE to retain category structure; each sub
+            Use @c wxPG_KEEP_STRUCTURE to retain category structure; each sub
             category will be its own wxVariantList of wxVariant.
-
+            Use @c wxPG_INC_ATTRIBUTES to include property attributes as well.
-            Use wxPG_INC_ATTRIBUTES to include property attributes as well.
             Each attribute will be stored as list variant named
-            "@@<propname>@@attr."
+            @"@@@<propname@>@@attr.@"
     */
     wxVariant GetPropertyValues( const wxString& listname = wxEmptyString,
                                  wxPGProperty* baseparent = NULL, long flags = 0 ) const;
@@ -586,7 +588,7 @@ public:
         Hides or reveals a property.
 
         @param id
-            @todo docme
+            Name or pointer to a property.
         @param hide
             If @true, hides property, otherwise reveals it.
         @param flags
@@ -703,8 +705,8 @@ public:
     bool IsPropertyValueUnspecified( wxPGPropArg id ) const;
 
     /**
-        Disables (limit = @true) or enables (limit = @false) wxTextCtrl editor
+        Disables (@a limit = @true) or enables (@a limit = @false) wxTextCtrl
-        of a property, if it is not the sole mean to edit the value.
+        editor of a property, if it is not the sole mean to edit the value.
 
         @remarks
         Property is refreshed with new settings.
@@ -712,7 +714,7 @@ public:
     void LimitPropertyEditing( wxPGPropArg id, bool limit = true );
 
     /**
-        If state is shown in it's grid, refresh it now.
+        If state is shown in its grid, refresh it now.
     */
     virtual void RefreshGrid( wxPropertyGridPageState* state = NULL );
 
@@ -864,7 +866,7 @@ public:
         Sets an attribute for this property.
 
         @param id
-            @todo docme
+            Name or pointer to a property.
         @param attrName
             Text identifier of attribute. See @ref propgrid_property_attributes.
         @param value
@@ -955,7 +957,7 @@ public:
         Sets editor for a property.
 
         @param id
-            @todo docme
+            Property name or pointer to a property.
         @param editor
             For builtin editors, use wxPGEditor_X, where X is builtin editor's
             name (TextCtrl, Choice, etc. see wxPGEditor documentation for full
@@ -1035,7 +1037,7 @@ public:
     /**
         Associates the help string with property.
 
-        @remarks By default, text is shown either in the manager's "description"
+        @remarks By default, text is shown either in the manager's @"description@"
                 text box or in the status bar. If extra window style
                 wxPG_EX_HELP_AS_TOOLTIPS is used, then the text will appear as
                 a tooltip.