[wx-dev] #9582: Improvement For Sample Documents

[wxTrac]

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

#9582: Improvement For Sample Documents
--------------------------+-------------------------------------------------
 Reporter:  Utensil       |       Owner:         
     Type:  enhancement   |      Status:  new    
 Priority:  normal        |   Milestone:         
Component:  doxygen docs  |     Version:  2.9-svn
 Keywords:                |   Blockedby:         
    Patch:  1             |    Blocking:         
--------------------------+-------------------------------------------------
 This patch is diffed against r54227(lately)

 Major Improvements:

 1) Change some of the section title from abbrievated form e.g.DnD, to full
 form e.g. Drag and Drop, so that people can have a general idea about the
 sample by looking at its title.

 2) Mention the name of the directory that contains the sample in a
 consistent way, by introducing the alias @sampledir{1}

 3) Mention the sample in the related class or overview, by introducing the
 alias @sample{1}. (This is only done in access.h and animate.h, as an
 preview, more will be done later)

 4) Wrote a brief description for every sample missed by the old doc, now
 there are 80+ samples described.

 Other Fixes:

 docs/doxygen/Doxyfile_inc

     Change ENUM_VALUES_PER_LINE from 4 to 1. After this change, the enums
 in the doc will be more tidy IMO. I was sick of the mix-together enum
 items for a long time, finally I found this option.

 samples/popup/popup.cpp

     Fix "Name: minimal.cpp" to "Name: popup.cpp"

 samples/power/power.cpp

     Fix non PCH compilation."wx/log.h" should have been included.


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