Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:24067
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Message-ID: <448A0AE8.1080509@lerdorf.com>
Date: Fri, 09 Jun 2006 16:57:28 -0700
User-Agent: Thunderbird 3.0a1 (Macintosh/20060414)
MIME-Version: 1.0
To: Marcus Boerger <helly@php.net>
CC: Andi Gutmans <andi@zend.com>, 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>
In-Reply-To: <673041320.20060610015205@marcus-boerger.de>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Subject: Re: [PHP-DEV] SPL docs
From: rasmus@lerdorf.com (Rasmus Lerdorf)

I find the Doxygen-generated SPL docs maze-like and pretty much 
impossible to navigate.  There is nothing stopping you from maintaining 
that separate document, but I'd love to see the useful bits integrated 
into the PHP docs.  Losing the inheritance graphs doesn't bother me a bit.

-Rasmus

Marcus Boerger wrote:
> Hello Andi,
> 
>   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.
> 
> best regards
> marcus
> 
> Friday, June 9, 2006, 3:57:12 PM, you wrote:
> 
>> This is a docbook limitation? Couldn't we still find some standard 
>> way to write it? most of it is manual stuff ala 
>> http://framework.zend.com/manual/en/zend.html?
>> No?
>> Andi
> 
> 
>> At 12:24 AM 6/9/2006, Marcus Boerger wrote:
>>> Hello Andi,
>>>
>>>   the problem is the non existing OO support in docbook. I had the idea
>>> of eventually using doxygen's xml output and putting that somehow in the
>>> manual. But that's is probably something for livedocs. So lets have
>>> livedocs first. Apart from that nobody hinders the doc team from copying
>>> and translating the stuff from the separate SPL docs to the manual. It is
>>> just impossible to integrate the inheritance info and all the graphics to
>>> the manual.
>>>
>>> best regards
>>> marcus
>>>
>>>
>>> Friday, June 9, 2006, 1:25:56 AM, you wrote:
>>>
>>>> Hey Marcus,
>>>> Any chance we can get the SPL docs integrated into the PHP manual? I
>>>> get questions about it here and there and think that as it's in the
>>>> default PHP distro it makes sense to have that as part of the
>>>> official PHP manual.
>>>> Andi
>>>
>>>
>>>
>>> Best regards,
>>>  Marcus
> 
> 
> 
> 
> Best regards,
>  Marcus
>