Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:37180
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain zend.com designates 212.25.124.185 as permitted sender)
Message-ID: <480E1B15.5050006@zend.com>
Date: Tue, 22 Apr 2008 10:06:29 -0700
Organization: Zend Technologies
User-Agent: Thunderbird 2.0.0.12 (Windows/20080213)
MIME-Version: 1.0
To: Marcus Boerger <helly@php.net>
CC: PHP internals <internals@lists.php.net>
References: <cd5680a20804110816o94cf3d6sd365160ba262ffc9@mail.gmail.com> <b5f7bf6c0804110842l256b8687yb183980e715ef549@mail.gmail.com> <e666c3890804110955i7616b8d3ref5c53349d45e8e8@mail.gmail.com> <97A40CDA-69F5-4CD5-8974-276625638380@roshambo.org> <147898898.20080422182434@marcus-boerger.de>
In-Reply-To: <147898898.20080422182434@marcus-boerger.de>
Content-Type: text/plain; charset=ISO-8859-15; format=flowed
Content-Transfer-Encoding: 7bit
Subject: Re: [PHP-DEV] spl documentation
From: stas@zend.com (Stanislav Malyshev)

Hi!

> Personally I tried for year to get some feedback on getting documentation
> to support classes. And we still do not have any acceptable support. So I

My impression is PhD now supports classes quite well. There are even 
skeletons as I understand :) I wonder how hard would it be to write a 
script to generate half-baked docbook files from the same data doxygen 
works with (my guesstimate would be couple of days effort, but that's 
just a guess :) for later manual editing.

> 1) delete all my documentation and/or simply ignore what I did and write
> whatever documentation you guys want. The code I use for doxygen would

I think deleting any docs would be a waste, and doxygen docs definitely 
have its use. They just don't replace the manual.

> 3) Finally support inheritance in the documentation and either generate
> inheritance- and call-graphs for the manual or simply use doxygens xml

I think manual needs just plain old method descriptions, etc. much more 
that inheritance graphs. Not to say those can't be useful - they can - 
but right now we don't have even the bare minimum - list of classes and 
methods which may say in plain text what inherits what. Once we have 
that, we might proceed to doing more cool stuff like inheritance graphs.
-- 
Stanislav Malyshev, Zend Software Architect
stas@zend.com   http://www.zend.com/
(408)253-8829   MSN: stas@zend.com