[wx-dev] #9581: Document Correction for q-r interface files except wxRichTextCtrl related files

[wxTrac]

Ticket URL: <http://trac.wxwidgets.org/ticket/9581>

#9581: Document Correction for q-r interface files except wxRichTextCtrl related
files
--------------------------+-------------------------------------------------
 Reporter:  Utensil       |       Owner:         
     Type:  defect        |      Status:  new    
 Priority:  normal        |   Milestone:         
Component:  doxygen docs  |     Version:  2.9-svn
 Keywords:                |   Blockedby:         
    Patch:  1             |    Blocking:         
--------------------------+-------------------------------------------------
 The patch is diffed against r54227(lately).

 Revision Notes:

 docs/doxygen/mainpages/platdetails.h

     Fixed the anchor error of wxCocoa port.

 interface/region.h

     Ordinary fixes.

 interface/radiobox.h

     Improve the appearance of the wxPython Note.

 interface/recguard.h

     Fix its Category to Miscellaneous.

 interface/regex.h

     From this file on, I start a convention of referring to the anonymous
 enums using the doxygen tag @anchor with a name like wxPrefixFlags e.g.
 wx(before this I tried using wxPREFIX_FLAGS and wxPREFIX_XXXX, but they
 were ugly). Before we can change the anonymous enum to named, this is the
 compromise for now. Without namely titles of the enums(they are only a
 titled "anonymous enum" by doxygen), I guess using this style is easier
 for user to know what flags they are reading.

 interface/config.h

     Mentioned wxRegKey beside wxRegConfig.

 interface/renderer.h

     1) I did something to the anonymous enum as I did in regex.h.

     2) FIXME: The catagory is a problem.

     wxSplitterRenderParams  and wxRendererVersion are helper structs only
 used by wxRendererNative, I couldn't place them into GDI catagory to
 pollute the GDI, so I left their cata in the status of FIXME.

     And should they be doced as struct or class? Since they are actually
 structs in the real header.

     3)TODO:  While I failed to find the wxHDR_ enum mentioned in it, I
 wonder why wxDoc doesn't have a complete list of all global enums? There
 is a Enumeration list of the class-member enums, but not for the global
 ones.

 interface/msw/registry.h

 Ordinary fixes.


--
Ticket URL: <http://trac.wxwidgets.org/ticket/9581>