[wx-dev] [wxdocs] update on the status of the conversion

[Kevin Ollivier]

Hi all,
On Jan 3, 2008 8:55 AM, Vadim Zeitlin <vadim at wxwidgets.org> wrote:

> On Wed, 02 Jan 2008 01:48:05 +0100 Francesco Montorsi <
> f18m_cpp217828 at yahoo.it> wrote:
>
> FM> QUESTION #1: are we still all convinced of the doxygen solution?
>
>  I was convinced by it but one of the arguments which carried a lot of
> weight for me was that this was something easy and (relatively) quick to
> do
> and now it seems that maybe it was a bit overoptimistic to believe it...


Actually, I think we're pretty far along, it's just that on my end wxWebKit
work is getting pretty frantic and taking up pretty much all my spare time.
That being said, we're probably getting close to the point where we can
start committing headers and doing clean up.

A lot of the docs are already being produced, but there will be some work
with data types and such, mostly us starting with the private headers and
cleaning them up. It will be work, but it'll be a one-time effort.

In the end, though, we have to look at the amount of work by comparing
solutions. IMHO this will be quicker than the custom docs migration, and I
think the fact that with this approach we've already produced a majority of
the docs (whereas we're not as far with wxDocs) is proof of that. The only
other option is doing nothing, and while I have to admit I'm slow to get
things done, I do think being slow is better than doing nothing when faced
with problems. ;-)

IMHO, if we commit to a solution and all put a bit of effort into it, it
will happen fairly quickly.


> FM> QUESTION #2 (assuming yes to Q#1): where are we going to put the new
> FM> ad-hoc headers ? Is wxWidgets/docs/interface a good place?
>
>  I don't think these files should go under docs if they're going to be
> used
> for wxPython (and other bindings) too. We should either put them under
> include or make a new top-level directory for them. I think I'd prefer the
> latter (it could be called "interface").


I like the interface idea too.


>
> FM> QUESTION #3 (assuming yes to Q#1): is it ok to migrate to the new doc
> FM> format even if it does not work yet for SWIG for wxPython/wxLua/etc?
>
>  Yes, I think so. As long as we can use these headers for the
> documentation, we should be ready to switch to them. Of course, I do hope
> that Robin can also use them for wxPython (and hence continue maintaining
> them :-) but it's not necessary to wait for it to happen if Robin is sure
> that this can be done.


Yes, step one is the docs, then we can fix things to work with SWIG. I don't
know if Francesco noticed, but the scripts also spit out template .i files
which will be the start of the SWIG migration. In my mind, though, once the
docs are done we can get SWIG to work with it. :-)

Regards,

Kevin


>
>  Thanks,
> VZ
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: wx-dev-unsubscribe at lists.wxwidgets.org
> For additional commands, e-mail: wx-dev-help at lists.wxwidgets.org
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.wxwidgets.org/pipermail/wx-dev/attachments/20080103/ea075=
851/attachment.htm