Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:24073
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Message-ID: <186701c68c7c$cffa7990$6602a8c0@foxbox>
Reply-To: "Steph Fox" <steph@zend.com>
To: "Marcus Boerger" <helly@php.net>, "Andi Gutmans" <andi@zend.com>
Cc: <internals@lists.php.net>
References: <7.0.1.0.2.20060608162444.06db8390@zend.com> <1934915062.20060609092414@marcus-boerger.de> <7.0.1.0.2.20060609065558.037ca148@zend.com> <673041320.20060610015205@marcus-boerger.de>
Date: Sat, 10 Jun 2006 12:58:30 +0200
MIME-Version: 1.0
Content-Type: text/plain;
	format=flowed;
	charset="Windows-1252";
	reply-type=original
Content-Transfer-Encoding: 7bit
Subject: Re: [PHP-DEV] SPL docs
From: steph@zend.com ("Steph Fox")

Hi Marcus

>  that's nothing more than our manual besides a different layout. I'd
> like to document how studd is being integrated, how stuff works together
> and how inheritance trees look like. You saw the gtk tree, wow, cool if
> there is only one real tree like inheritance graph. But unfortunatley
> SPL has a great amount of interfaces floating around. Intrgrating that
> and hving all that information revealed is a great problem. I use the
> docu myself so maybe i am looking from another level but i am not
> willing to give that level away. I'd rather change the toolset, only the
> toolchain i can change is doxygen.

Yep, we're about to hit similar issues over documenting interfaces in 
PHP-GTK...  at present they're more or less treated as classes. I really 
don't want to throw away the entire php-gtk-doc structure just to deal with 
those though :) and I'd imagine nobody wants to throw out the otherwise 
solid phpdoc structure either.

I have to say also that I don't find doxygen-generated documentation 
intuitive. It's more useful if you already know about something and need to 
look up some detail than it is if you're trying to learn how that thing 
works in the first place.

- Steph