« Return to Thread: API Documentation Generation

Re: API Documentation Generation

by Till Klampaeckel-2 :: Rate this Message:

| View in Thread

On Sat, Sep 17, 2011 at 3:18 AM, Daniel O'Connor
<daniel.oconnor@...> wrote:
> http://test.pear.php.net/package/Validate_HU/docs/latest/
> Looks good to me!
>
> Any other thoughts?

Not to rain on your parade – but I think we're almost there! :-)

http://cl.ly/012f1H0V0X132L3V2D3e

See the blank space? Is it missing something there...?

Quickthoughts:

 * the spacing to the right of the tree is messed (margin, I'm
guessing – part of the text is hidden)
 * the folder icons – is it easy to replace them with something pear
colored? ;-)
 * i'd always display the methods' parameters and return value (none
of this slide out/up stuff)
 * is inheritance diagram broken?
 * files 'tab' is barely clickable
 * is files supposed to show code? if not, since we have the one class
per file rule it seems redundant for PEAR

... before I continue. Do you mind running it for the entire validate
package to see 'more'?

Till

--
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

 « Return to Thread: API Documentation Generation