Ideas for the doxydocs

[Francesco Montorsi]

Hi,

Vadim Zeitlin ha scritto:
> On Thu, 28 Feb 2008 09:28:48 +0100 Francesco Montorsi <f18m_cpp217828 at yahoo.it> wrote:
> 
> FM> @category{GUI classes} <-- would be present for each @class and could be 
> FM> used by an external script to generate the mainpages/categories.h page 
> FM> besides adding a "Category" section in the API doc for that class
> FM> 
> FM> @nativeimpl{wxgtk,wxmsw} <-- would be present only where needed and 
> FM> could be used by an external script to generate a new 
> FM> mainpages/native_classes.h page besides adding a "Native implementation 
> FM> under" section in the API doc for that class
> FM> 
> FM> @genericimpl{wxuniv,wxmac} <-- just like above except that it would 
> FM> signal a generic implementation instead of a native one. However we 
> FM> could assume that if class X has not port Y listed under @nativeimpl{} 
> FM> then it's generic under port Y; this would make this tag useless and 
> FM> avoid redundancy.
> FM> 
> FM> @onlyfor{wxmsw} <-- for port-specific classes
> FM> 
> FM> @appeareance{button.png} <-- for classes in the category "GUI classes"; 
> FM> would make the docs very nice if someone takes out screenshots of all 
> FM> our GUI classes for both wxMsw, wxMac, wxGTK.
> FM> The above @appearance tag could in fact expand to
> FM>     @image html wxmsw/button.png
> FM>     @image html wxmac/button.png
> FM>     @image html wxgtk/button.png
> FM> (with some other markup to add labels to the images).
> 
>  All those seem like a good ideas,
Ok; btw I suppose that we agree not to use the @genericimpl{...} tag and
simply consider all implementations generic unless otherwise explicitly
noted (through @nativeimpl).

> especially the last one -- we really
> need the screenshots. Except that we're unlikely to add the screenshots for
> all ports at once so it would be great if we could specify for which ports
> they're available, e.g. would @appearance[msw,gtk]{button} be possible?
no, but @appearance{msw}{button}, @appearance{gtk}{button}, ... would be.

> If not, we need @appearance_msw{button} and @appearance_gtk{button} probably.
instead I think that asking the help of people on wx-users we can build
a "database" of all GUI controls in few time and thus simply put
(automatically through the conversion script) the @appearance tag
everywhere and make it expand to images for wxGTK, wxMSW, wxMac.

I've updated
   http://www.wxwidgets.org/wiki/index.php/Development:_Doxydocs_review
and will post to wx-users, if you agree on the contents of that page 
(which controls to screenshot and under which conditions).

In particular I don't know nothing about wxMac and have placed there 
requirements on the Mac platform just looking at wikipedia and the wxMac 
line also doesn't contain any reference to the theme name.

Francesco